Category
GET
Retrieve categories by conditions
_cnd[parent]
integer
Filters categories by parent id
_cnd[subTree]
integer
Retrieve categories subtree by parent id
_cnd[term]
string
Search by term
_cnd[limit]
array
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array
Sets sorting order field
default Success <XLite\Model\Category>[] array
Sample response
[{"coupons":[{"id":"integer","code":"string","enabled":"boolean","value":"string","type":"string","comment":"string","uses":"integer","dateRangeBegin":"integer","dateRangeEnd":"integer","totalRangeBegin":"string","totalRangeEnd":"string","usesLimit":"integer","usesLimitPerUser":"integer","singleUse":"boolean","productClasses":"<XLite\\Model\\ProductClass>[] array","memberships":"<XLite\\Model\\Membership>[] array","usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","categories":"<XLite\\Model\\Category>[] array"}],"featuredProducts":[{"id":"integer","orderBy":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>"}],"ogMeta":"example","useCustomOG":true,"productClasses":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","categories":"<XLite\\Model\\Category>[] array","id":"integer","position":"integer","attributes":"<XLite\\Model\\Attribute>[] array","attribute_groups":"<XLite\\Model\\AttributeGroup>[] array"}],"useClasses":"example","category_id":24,"lpos":23,"rpos":15,"enabled":false,"show_title":true,"depth":13,"pos":78,"root_category_look":"example","quickFlags":{"id":"integer","subcategories_count_all":"integer","subcategories_count_enabled":"integer","category":"<XLite\\Model\\Category>"},"memberships":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}],"image":{"category":"<XLite\\Model\\Category>","alt":"string","s3icons":"anything[] array","needMigration":"boolean","width":"integer","height":"integer","hash":"string","needProcess":"boolean","id":"integer","path":"string","fileName":"string","mime":"string","storageType":"string","size":"integer","date":"integer"},"banner":{"category":"<XLite\\Model\\Category>","alt":"string","s3icons":"anything[] array","needMigration":"boolean","width":"integer","height":"integer","hash":"string","needProcess":"boolean","id":"integer","path":"string","fileName":"string","mime":"string","storageType":"string","size":"integer","date":"integer"},"categoryProducts":[{"id":"integer","orderby":"integer","category":"<category object>","product":"<product object>"}],"children":["<XLite\\Model\\Category>"],"parent":"<XLite\\Model\\Category>","cleanURLs":[{"page":"<XLite\\Module\\CDev\\SimpleCMS\\Model\\Page>","newsMessage":"<XLite\\Module\\XC\\News\\Model\\NewsMessage>","id":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>","cleanURL":"string"}],"metaDescType":"example","xcPendingExport":false,"lastUsage":5}]
_cnd[parent]
integer
Filters categories by parent id
_cnd[subTree]
integer
Retrieve categories subtree by parent id
_cnd[term]
string
Search by term
_cnd[limit]
array
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array
Sets sorting order field
default Success <XLite\Model\Category>[] array
Sample response
[{"coupons":[{"id":"integer","code":"string","enabled":"boolean","value":"string","type":"string","comment":"string","uses":"integer","dateRangeBegin":"integer","dateRangeEnd":"integer","totalRangeBegin":"string","totalRangeEnd":"string","usesLimit":"integer","usesLimitPerUser":"integer","singleUse":"boolean","productClasses":"<XLite\\Model\\ProductClass>[] array","memberships":"<XLite\\Model\\Membership>[] array","usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","categories":"<XLite\\Model\\Category>[] array"}],"featuredProducts":[{"id":"integer","orderBy":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>"}],"ogMeta":"example","useCustomOG":true,"productClasses":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","categories":"<XLite\\Model\\Category>[] array","id":"integer","position":"integer","attributes":"<XLite\\Model\\Attribute>[] array","attribute_groups":"<XLite\\Model\\AttributeGroup>[] array"}],"useClasses":"example","category_id":24,"lpos":23,"rpos":15,"enabled":false,"show_title":true,"depth":13,"pos":78,"root_category_look":"example","quickFlags":{"id":"integer","subcategories_count_all":"integer","subcategories_count_enabled":"integer","category":"<XLite\\Model\\Category>"},"memberships":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}],"image":{"category":"<XLite\\Model\\Category>","alt":"string","s3icons":"anything[] array","needMigration":"boolean","width":"integer","height":"integer","hash":"string","needProcess":"boolean","id":"integer","path":"string","fileName":"string","mime":"string","storageType":"string","size":"integer","date":"integer"},"banner":{"category":"<XLite\\Model\\Category>","alt":"string","s3icons":"anything[] array","needMigration":"boolean","width":"integer","height":"integer","hash":"string","needProcess":"boolean","id":"integer","path":"string","fileName":"string","mime":"string","storageType":"string","size":"integer","date":"integer"},"categoryProducts":[{"id":"integer","orderby":"integer","category":"<category object>","product":"<product object>"}],"children":["<XLite\\Model\\Category>"],"parent":"<XLite\\Model\\Category>","cleanURLs":[{"page":"<XLite\\Module\\CDev\\SimpleCMS\\Model\\Page>","newsMessage":"<XLite\\Module\\XC\\News\\Model\\NewsMessage>","id":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>","cleanURL":"string"}],"metaDescType":"example","xcPendingExport":false,"lastUsage":5}]
GET
Retrieve category by id
id
integer Required
Id value of the Category object
default Success <XLite\Model\Category>
Sample response
{"coupons":[{"id":"integer","code":"string","enabled":"boolean","value":"string","type":"string","comment":"string","uses":"integer","dateRangeBegin":"integer","dateRangeEnd":"integer","totalRangeBegin":"string","totalRangeEnd":"string","usesLimit":"integer","usesLimitPerUser":"integer","singleUse":"boolean","productClasses":"<XLite\\Model\\ProductClass>[] array","memberships":"<XLite\\Model\\Membership>[] array","usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","categories":"<XLite\\Model\\Category>[] array"}],"featuredProducts":[{"id":"integer","orderBy":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>"}],"ogMeta":"example","useCustomOG":true,"productClasses":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","categories":"<XLite\\Model\\Category>[] array","id":"integer","position":"integer","attributes":"<XLite\\Model\\Attribute>[] array","attribute_groups":"<XLite\\Model\\AttributeGroup>[] array"}],"useClasses":"example","category_id":24,"lpos":23,"rpos":15,"enabled":false,"show_title":true,"depth":13,"pos":78,"root_category_look":"example","quickFlags":{"id":"integer","subcategories_count_all":"integer","subcategories_count_enabled":"integer","category":"<XLite\\Model\\Category>"},"memberships":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}],"image":{"category":"<XLite\\Model\\Category>","alt":"string","s3icons":"anything[] array","needMigration":"boolean","width":"integer","height":"integer","hash":"string","needProcess":"boolean","id":"integer","path":"string","fileName":"string","mime":"string","storageType":"string","size":"integer","date":"integer"},"banner":{"category":"<XLite\\Model\\Category>","alt":"string","s3icons":"anything[] array","needMigration":"boolean","width":"integer","height":"integer","hash":"string","needProcess":"boolean","id":"integer","path":"string","fileName":"string","mime":"string","storageType":"string","size":"integer","date":"integer"},"categoryProducts":[{"id":"integer","orderby":"integer","category":"<category object>","product":"<product object>"}],"children":["<XLite\\Model\\Category>"],"parent":"<XLite\\Model\\Category>","cleanURLs":[{"page":"<XLite\\Module\\CDev\\SimpleCMS\\Model\\Page>","newsMessage":"<XLite\\Module\\XC\\News\\Model\\NewsMessage>","id":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>","cleanURL":"string"}],"metaDescType":"example","xcPendingExport":false,"lastUsage":5}
coupons
[] array
Coupons
featuredProducts
[] array
Featured products (relation)
ogMeta
string
Custom Open graph meta tags
useCustomOG
boolean
User Open graph meta tags generator flag
demo
boolean
Flag, if the product participates in the sale
productClasses
[] array
Category classes
useClasses
string
Status code
category_id
integer
Node unique ID
lpos
integer
Node left value
rpos
integer
Node right value
enabled
boolean
Node status
show_title
boolean
Whether to display the category title, or not
depth
integer
Category "depth" in the tree
pos
integer
Category position parameter. Sort inside the parent category
root_category_look
string
Whether to display the category title, or not
quickFlags
[] array
Memberships
image
[] array
Relation to a CategoryProducts entities
children
[] array
Child categories
parent
[] array
Clean URLs
metaDescType
string
Meta description type
xcPendingExport
boolean
Flag to exporting entities
id
integer Required
Id value of the Category object
default Success <XLite\Model\Category>
Sample response
{"coupons":[{"id":"integer","code":"string","enabled":"boolean","value":"string","type":"string","comment":"string","uses":"integer","dateRangeBegin":"integer","dateRangeEnd":"integer","totalRangeBegin":"string","totalRangeEnd":"string","usesLimit":"integer","usesLimitPerUser":"integer","singleUse":"boolean","productClasses":"<XLite\\Model\\ProductClass>[] array","memberships":"<XLite\\Model\\Membership>[] array","usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","categories":"<XLite\\Model\\Category>[] array"}],"featuredProducts":[{"id":"integer","orderBy":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>"}],"ogMeta":"example","useCustomOG":true,"productClasses":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","categories":"<XLite\\Model\\Category>[] array","id":"integer","position":"integer","attributes":"<XLite\\Model\\Attribute>[] array","attribute_groups":"<XLite\\Model\\AttributeGroup>[] array"}],"useClasses":"example","category_id":24,"lpos":23,"rpos":15,"enabled":false,"show_title":true,"depth":13,"pos":78,"root_category_look":"example","quickFlags":{"id":"integer","subcategories_count_all":"integer","subcategories_count_enabled":"integer","category":"<XLite\\Model\\Category>"},"memberships":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}],"image":{"category":"<XLite\\Model\\Category>","alt":"string","s3icons":"anything[] array","needMigration":"boolean","width":"integer","height":"integer","hash":"string","needProcess":"boolean","id":"integer","path":"string","fileName":"string","mime":"string","storageType":"string","size":"integer","date":"integer"},"banner":{"category":"<XLite\\Model\\Category>","alt":"string","s3icons":"anything[] array","needMigration":"boolean","width":"integer","height":"integer","hash":"string","needProcess":"boolean","id":"integer","path":"string","fileName":"string","mime":"string","storageType":"string","size":"integer","date":"integer"},"categoryProducts":[{"id":"integer","orderby":"integer","category":"<category object>","product":"<product object>"}],"children":["<XLite\\Model\\Category>"],"parent":"<XLite\\Model\\Category>","cleanURLs":[{"page":"<XLite\\Module\\CDev\\SimpleCMS\\Model\\Page>","newsMessage":"<XLite\\Module\\XC\\News\\Model\\NewsMessage>","id":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>","cleanURL":"string"}],"metaDescType":"example","xcPendingExport":false,"lastUsage":5}
coupons
Coupons
featuredProducts
Featured products (relation)
ogMeta
string
Custom Open graph meta tags
useCustomOG
boolean
User Open graph meta tags generator flag
demo
boolean
Flag, if the product participates in the sale
productClasses
Category classes
useClasses
string
Status code
category_id
integer
Node unique ID
lpos
integer
Node left value
rpos
integer
Node right value
enabled
boolean
Node status
show_title
boolean
Whether to display the category title, or not
depth
integer
Category "depth" in the tree
pos
integer
Category position parameter. Sort inside the parent category
root_category_look
string
Whether to display the category title, or not
quickFlags
memberships
Memberships
image
banner
categoryProducts
Relation to a CategoryProducts entities
children
Child categories
parent
cleanURLs
Clean URLs
metaDescType
string
Meta description type
xcPendingExport
boolean
Flag to exporting entities
PUT
Update category by id
id
integer Required
Id value of the Category object
<XLite\Model\Category>
coupons
[] array
Coupons
featuredProducts
[] array
Featured products (relation)
ogMeta
string
Custom Open graph meta tags
useCustomOG
boolean
User Open graph meta tags generator flag
demo
boolean
Flag, if the product participates in the sale
productClasses
[] array
Category classes
useClasses
string
Status code
category_id
integer
Node unique ID
lpos
integer
Node left value
rpos
integer
Node right value
enabled
boolean
Node status
show_title
boolean
Whether to display the category title, or not
depth
integer
Category "depth" in the tree
pos
integer
Category position parameter. Sort inside the parent category
root_category_look
string
Whether to display the category title, or not
quickFlags
[] array
Memberships
image
[] array
Relation to a CategoryProducts entities
children
[] array
Child categories
parent
[] array
Clean URLs
metaDescType
string
Meta description type
xcPendingExport
boolean
Flag to exporting entities
default Success <XLite\Model\Category>
Sample response
{"coupons":[{"id":"integer","code":"string","enabled":"boolean","value":"string","type":"string","comment":"string","uses":"integer","dateRangeBegin":"integer","dateRangeEnd":"integer","totalRangeBegin":"string","totalRangeEnd":"string","usesLimit":"integer","usesLimitPerUser":"integer","singleUse":"boolean","productClasses":"<XLite\\Model\\ProductClass>[] array","memberships":"<XLite\\Model\\Membership>[] array","usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","categories":"<XLite\\Model\\Category>[] array"}],"featuredProducts":[{"id":"integer","orderBy":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>"}],"ogMeta":"example","useCustomOG":true,"productClasses":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","categories":"<XLite\\Model\\Category>[] array","id":"integer","position":"integer","attributes":"<XLite\\Model\\Attribute>[] array","attribute_groups":"<XLite\\Model\\AttributeGroup>[] array"}],"useClasses":"example","category_id":24,"lpos":23,"rpos":15,"enabled":false,"show_title":true,"depth":13,"pos":78,"root_category_look":"example","quickFlags":{"id":"integer","subcategories_count_all":"integer","subcategories_count_enabled":"integer","category":"<XLite\\Model\\Category>"},"memberships":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}],"image":{"category":"<XLite\\Model\\Category>","alt":"string","s3icons":"anything[] array","needMigration":"boolean","width":"integer","height":"integer","hash":"string","needProcess":"boolean","id":"integer","path":"string","fileName":"string","mime":"string","storageType":"string","size":"integer","date":"integer"},"banner":{"category":"<XLite\\Model\\Category>","alt":"string","s3icons":"anything[] array","needMigration":"boolean","width":"integer","height":"integer","hash":"string","needProcess":"boolean","id":"integer","path":"string","fileName":"string","mime":"string","storageType":"string","size":"integer","date":"integer"},"categoryProducts":[{"id":"integer","orderby":"integer","category":"<category object>","product":"<product object>"}],"children":["<XLite\\Model\\Category>"],"parent":"<XLite\\Model\\Category>","cleanURLs":[{"page":"<XLite\\Module\\CDev\\SimpleCMS\\Model\\Page>","newsMessage":"<XLite\\Module\\XC\\News\\Model\\NewsMessage>","id":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>","cleanURL":"string"}],"metaDescType":"example","xcPendingExport":false,"lastUsage":5}
coupons
[] array
Coupons
featuredProducts
[] array
Featured products (relation)
ogMeta
string
Custom Open graph meta tags
useCustomOG
boolean
User Open graph meta tags generator flag
demo
boolean
Flag, if the product participates in the sale
productClasses
[] array
Category classes
useClasses
string
Status code
category_id
integer
Node unique ID
lpos
integer
Node left value
rpos
integer
Node right value
enabled
boolean
Node status
show_title
boolean
Whether to display the category title, or not
depth
integer
Category "depth" in the tree
pos
integer
Category position parameter. Sort inside the parent category
root_category_look
string
Whether to display the category title, or not
quickFlags
[] array
Memberships
image
[] array
Relation to a CategoryProducts entities
children
[] array
Child categories
parent
[] array
Clean URLs
metaDescType
string
Meta description type
xcPendingExport
boolean
Flag to exporting entities
id
integer Required
Id value of the Category object
<XLite\Model\Category>
coupons
Coupons
featuredProducts
Featured products (relation)
ogMeta
string
Custom Open graph meta tags
useCustomOG
boolean
User Open graph meta tags generator flag
demo
boolean
Flag, if the product participates in the sale
productClasses
Category classes
useClasses
string
Status code
category_id
integer
Node unique ID
lpos
integer
Node left value
rpos
integer
Node right value
enabled
boolean
Node status
show_title
boolean
Whether to display the category title, or not
depth
integer
Category "depth" in the tree
pos
integer
Category position parameter. Sort inside the parent category
root_category_look
string
Whether to display the category title, or not
quickFlags
memberships
Memberships
image
banner
categoryProducts
Relation to a CategoryProducts entities
children
Child categories
parent
cleanURLs
Clean URLs
metaDescType
string
Meta description type
xcPendingExport
boolean
Flag to exporting entities
default Success <XLite\Model\Category>
Sample response
{"coupons":[{"id":"integer","code":"string","enabled":"boolean","value":"string","type":"string","comment":"string","uses":"integer","dateRangeBegin":"integer","dateRangeEnd":"integer","totalRangeBegin":"string","totalRangeEnd":"string","usesLimit":"integer","usesLimitPerUser":"integer","singleUse":"boolean","productClasses":"<XLite\\Model\\ProductClass>[] array","memberships":"<XLite\\Model\\Membership>[] array","usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","categories":"<XLite\\Model\\Category>[] array"}],"featuredProducts":[{"id":"integer","orderBy":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>"}],"ogMeta":"example","useCustomOG":true,"productClasses":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","categories":"<XLite\\Model\\Category>[] array","id":"integer","position":"integer","attributes":"<XLite\\Model\\Attribute>[] array","attribute_groups":"<XLite\\Model\\AttributeGroup>[] array"}],"useClasses":"example","category_id":24,"lpos":23,"rpos":15,"enabled":false,"show_title":true,"depth":13,"pos":78,"root_category_look":"example","quickFlags":{"id":"integer","subcategories_count_all":"integer","subcategories_count_enabled":"integer","category":"<XLite\\Model\\Category>"},"memberships":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}],"image":{"category":"<XLite\\Model\\Category>","alt":"string","s3icons":"anything[] array","needMigration":"boolean","width":"integer","height":"integer","hash":"string","needProcess":"boolean","id":"integer","path":"string","fileName":"string","mime":"string","storageType":"string","size":"integer","date":"integer"},"banner":{"category":"<XLite\\Model\\Category>","alt":"string","s3icons":"anything[] array","needMigration":"boolean","width":"integer","height":"integer","hash":"string","needProcess":"boolean","id":"integer","path":"string","fileName":"string","mime":"string","storageType":"string","size":"integer","date":"integer"},"categoryProducts":[{"id":"integer","orderby":"integer","category":"<category object>","product":"<product object>"}],"children":["<XLite\\Model\\Category>"],"parent":"<XLite\\Model\\Category>","cleanURLs":[{"page":"<XLite\\Module\\CDev\\SimpleCMS\\Model\\Page>","newsMessage":"<XLite\\Module\\XC\\News\\Model\\NewsMessage>","id":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>","cleanURL":"string"}],"metaDescType":"example","xcPendingExport":false,"lastUsage":5}
coupons
Coupons
featuredProducts
Featured products (relation)
ogMeta
string
Custom Open graph meta tags
useCustomOG
boolean
User Open graph meta tags generator flag
demo
boolean
Flag, if the product participates in the sale
productClasses
Category classes
useClasses
string
Status code
category_id
integer
Node unique ID
lpos
integer
Node left value
rpos
integer
Node right value
enabled
boolean
Node status
show_title
boolean
Whether to display the category title, or not
depth
integer
Category "depth" in the tree
pos
integer
Category position parameter. Sort inside the parent category
root_category_look
string
Whether to display the category title, or not
quickFlags
memberships
Memberships
image
banner
categoryProducts
Relation to a CategoryProducts entities
children
Child categories
parent
cleanURLs
Clean URLs
metaDescType
string
Meta description type
xcPendingExport
boolean
Flag to exporting entities
DELETE
Delete category by id
id
integer Required
Id value of the Category object
default Success <XLite\Model\Category>
Sample response
{"coupons":[{"id":"integer","code":"string","enabled":"boolean","value":"string","type":"string","comment":"string","uses":"integer","dateRangeBegin":"integer","dateRangeEnd":"integer","totalRangeBegin":"string","totalRangeEnd":"string","usesLimit":"integer","usesLimitPerUser":"integer","singleUse":"boolean","productClasses":"<XLite\\Model\\ProductClass>[] array","memberships":"<XLite\\Model\\Membership>[] array","usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","categories":"<XLite\\Model\\Category>[] array"}],"featuredProducts":[{"id":"integer","orderBy":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>"}],"ogMeta":"example","useCustomOG":true,"productClasses":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","categories":"<XLite\\Model\\Category>[] array","id":"integer","position":"integer","attributes":"<XLite\\Model\\Attribute>[] array","attribute_groups":"<XLite\\Model\\AttributeGroup>[] array"}],"useClasses":"example","category_id":24,"lpos":23,"rpos":15,"enabled":false,"show_title":true,"depth":13,"pos":78,"root_category_look":"example","quickFlags":{"id":"integer","subcategories_count_all":"integer","subcategories_count_enabled":"integer","category":"<XLite\\Model\\Category>"},"memberships":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}],"image":{"category":"<XLite\\Model\\Category>","alt":"string","s3icons":"anything[] array","needMigration":"boolean","width":"integer","height":"integer","hash":"string","needProcess":"boolean","id":"integer","path":"string","fileName":"string","mime":"string","storageType":"string","size":"integer","date":"integer"},"banner":{"category":"<XLite\\Model\\Category>","alt":"string","s3icons":"anything[] array","needMigration":"boolean","width":"integer","height":"integer","hash":"string","needProcess":"boolean","id":"integer","path":"string","fileName":"string","mime":"string","storageType":"string","size":"integer","date":"integer"},"categoryProducts":[{"id":"integer","orderby":"integer","category":"<category object>","product":"<product object>"}],"children":["<XLite\\Model\\Category>"],"parent":"<XLite\\Model\\Category>","cleanURLs":[{"page":"<XLite\\Module\\CDev\\SimpleCMS\\Model\\Page>","newsMessage":"<XLite\\Module\\XC\\News\\Model\\NewsMessage>","id":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>","cleanURL":"string"}],"metaDescType":"example","xcPendingExport":false,"lastUsage":5}
coupons
[] array
Coupons
featuredProducts
[] array
Featured products (relation)
ogMeta
string
Custom Open graph meta tags
useCustomOG
boolean
User Open graph meta tags generator flag
demo
boolean
Flag, if the product participates in the sale
productClasses
[] array
Category classes
useClasses
string
Status code
category_id
integer
Node unique ID
lpos
integer
Node left value
rpos
integer
Node right value
enabled
boolean
Node status
show_title
boolean
Whether to display the category title, or not
depth
integer
Category "depth" in the tree
pos
integer
Category position parameter. Sort inside the parent category
root_category_look
string
Whether to display the category title, or not
quickFlags
[] array
Memberships
image
[] array
Relation to a CategoryProducts entities
children
[] array
Child categories
parent
[] array
Clean URLs
metaDescType
string
Meta description type
xcPendingExport
boolean
Flag to exporting entities
id
integer Required
Id value of the Category object
default Success <XLite\Model\Category>
Sample response
{"coupons":[{"id":"integer","code":"string","enabled":"boolean","value":"string","type":"string","comment":"string","uses":"integer","dateRangeBegin":"integer","dateRangeEnd":"integer","totalRangeBegin":"string","totalRangeEnd":"string","usesLimit":"integer","usesLimitPerUser":"integer","singleUse":"boolean","productClasses":"<XLite\\Model\\ProductClass>[] array","memberships":"<XLite\\Model\\Membership>[] array","usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","categories":"<XLite\\Model\\Category>[] array"}],"featuredProducts":[{"id":"integer","orderBy":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>"}],"ogMeta":"example","useCustomOG":true,"productClasses":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","categories":"<XLite\\Model\\Category>[] array","id":"integer","position":"integer","attributes":"<XLite\\Model\\Attribute>[] array","attribute_groups":"<XLite\\Model\\AttributeGroup>[] array"}],"useClasses":"example","category_id":24,"lpos":23,"rpos":15,"enabled":false,"show_title":true,"depth":13,"pos":78,"root_category_look":"example","quickFlags":{"id":"integer","subcategories_count_all":"integer","subcategories_count_enabled":"integer","category":"<XLite\\Model\\Category>"},"memberships":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}],"image":{"category":"<XLite\\Model\\Category>","alt":"string","s3icons":"anything[] array","needMigration":"boolean","width":"integer","height":"integer","hash":"string","needProcess":"boolean","id":"integer","path":"string","fileName":"string","mime":"string","storageType":"string","size":"integer","date":"integer"},"banner":{"category":"<XLite\\Model\\Category>","alt":"string","s3icons":"anything[] array","needMigration":"boolean","width":"integer","height":"integer","hash":"string","needProcess":"boolean","id":"integer","path":"string","fileName":"string","mime":"string","storageType":"string","size":"integer","date":"integer"},"categoryProducts":[{"id":"integer","orderby":"integer","category":"<category object>","product":"<product object>"}],"children":["<XLite\\Model\\Category>"],"parent":"<XLite\\Model\\Category>","cleanURLs":[{"page":"<XLite\\Module\\CDev\\SimpleCMS\\Model\\Page>","newsMessage":"<XLite\\Module\\XC\\News\\Model\\NewsMessage>","id":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>","cleanURL":"string"}],"metaDescType":"example","xcPendingExport":false,"lastUsage":5}
coupons
Coupons
featuredProducts
Featured products (relation)
ogMeta
string
Custom Open graph meta tags
useCustomOG
boolean
User Open graph meta tags generator flag
demo
boolean
Flag, if the product participates in the sale
productClasses
Category classes
useClasses
string
Status code
category_id
integer
Node unique ID
lpos
integer
Node left value
rpos
integer
Node right value
enabled
boolean
Node status
show_title
boolean
Whether to display the category title, or not
depth
integer
Category "depth" in the tree
pos
integer
Category position parameter. Sort inside the parent category
root_category_look
string
Whether to display the category title, or not
quickFlags
memberships
Memberships
image
banner
categoryProducts
Relation to a CategoryProducts entities
children
Child categories
parent
cleanURLs
Clean URLs
metaDescType
string
Meta description type
xcPendingExport
boolean
Flag to exporting entities
POST
Add new category
<XLite\Model\Category>
coupons
[] array
Coupons
featuredProducts
[] array
Featured products (relation)
ogMeta
string
Custom Open graph meta tags
useCustomOG
boolean
User Open graph meta tags generator flag
demo
boolean
Flag, if the product participates in the sale
productClasses
[] array
Category classes
useClasses
string
Status code
category_id
integer
Node unique ID
lpos
integer
Node left value
rpos
integer
Node right value
enabled
boolean
Node status
show_title
boolean
Whether to display the category title, or not
depth
integer
Category "depth" in the tree
pos
integer
Category position parameter. Sort inside the parent category
root_category_look
string
Whether to display the category title, or not
quickFlags
[] array
Memberships
image
[] array
Relation to a CategoryProducts entities
children
[] array
Child categories
parent
[] array
Clean URLs
metaDescType
string
Meta description type
xcPendingExport
boolean
Flag to exporting entities
default Success <XLite\Model\Category>
Sample response
{"coupons":[{"id":"integer","code":"string","enabled":"boolean","value":"string","type":"string","comment":"string","uses":"integer","dateRangeBegin":"integer","dateRangeEnd":"integer","totalRangeBegin":"string","totalRangeEnd":"string","usesLimit":"integer","usesLimitPerUser":"integer","singleUse":"boolean","productClasses":"<XLite\\Model\\ProductClass>[] array","memberships":"<XLite\\Model\\Membership>[] array","usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","categories":"<XLite\\Model\\Category>[] array"}],"featuredProducts":[{"id":"integer","orderBy":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>"}],"ogMeta":"example","useCustomOG":true,"productClasses":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","categories":"<XLite\\Model\\Category>[] array","id":"integer","position":"integer","attributes":"<XLite\\Model\\Attribute>[] array","attribute_groups":"<XLite\\Model\\AttributeGroup>[] array"}],"useClasses":"example","category_id":24,"lpos":23,"rpos":15,"enabled":false,"show_title":true,"depth":13,"pos":78,"root_category_look":"example","quickFlags":{"id":"integer","subcategories_count_all":"integer","subcategories_count_enabled":"integer","category":"<XLite\\Model\\Category>"},"memberships":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}],"image":{"category":"<XLite\\Model\\Category>","alt":"string","s3icons":"anything[] array","needMigration":"boolean","width":"integer","height":"integer","hash":"string","needProcess":"boolean","id":"integer","path":"string","fileName":"string","mime":"string","storageType":"string","size":"integer","date":"integer"},"banner":{"category":"<XLite\\Model\\Category>","alt":"string","s3icons":"anything[] array","needMigration":"boolean","width":"integer","height":"integer","hash":"string","needProcess":"boolean","id":"integer","path":"string","fileName":"string","mime":"string","storageType":"string","size":"integer","date":"integer"},"categoryProducts":[{"id":"integer","orderby":"integer","category":"<category object>","product":"<product object>"}],"children":["<XLite\\Model\\Category>"],"parent":"<XLite\\Model\\Category>","cleanURLs":[{"page":"<XLite\\Module\\CDev\\SimpleCMS\\Model\\Page>","newsMessage":"<XLite\\Module\\XC\\News\\Model\\NewsMessage>","id":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>","cleanURL":"string"}],"metaDescType":"example","xcPendingExport":false,"lastUsage":5}
coupons
[] array
Coupons
featuredProducts
[] array
Featured products (relation)
ogMeta
string
Custom Open graph meta tags
useCustomOG
boolean
User Open graph meta tags generator flag
demo
boolean
Flag, if the product participates in the sale
productClasses
[] array
Category classes
useClasses
string
Status code
category_id
integer
Node unique ID
lpos
integer
Node left value
rpos
integer
Node right value
enabled
boolean
Node status
show_title
boolean
Whether to display the category title, or not
depth
integer
Category "depth" in the tree
pos
integer
Category position parameter. Sort inside the parent category
root_category_look
string
Whether to display the category title, or not
quickFlags
[] array
Memberships
image
[] array
Relation to a CategoryProducts entities
children
[] array
Child categories
parent
[] array
Clean URLs
metaDescType
string
Meta description type
xcPendingExport
boolean
Flag to exporting entities
<XLite\Model\Category>
coupons
Coupons
featuredProducts
Featured products (relation)
ogMeta
string
Custom Open graph meta tags
useCustomOG
boolean
User Open graph meta tags generator flag
demo
boolean
Flag, if the product participates in the sale
productClasses
Category classes
useClasses
string
Status code
category_id
integer
Node unique ID
lpos
integer
Node left value
rpos
integer
Node right value
enabled
boolean
Node status
show_title
boolean
Whether to display the category title, or not
depth
integer
Category "depth" in the tree
pos
integer
Category position parameter. Sort inside the parent category
root_category_look
string
Whether to display the category title, or not
quickFlags
memberships
Memberships
image
banner
categoryProducts
Relation to a CategoryProducts entities
children
Child categories
parent
cleanURLs
Clean URLs
metaDescType
string
Meta description type
xcPendingExport
boolean
Flag to exporting entities
default Success <XLite\Model\Category>
Sample response
{"coupons":[{"id":"integer","code":"string","enabled":"boolean","value":"string","type":"string","comment":"string","uses":"integer","dateRangeBegin":"integer","dateRangeEnd":"integer","totalRangeBegin":"string","totalRangeEnd":"string","usesLimit":"integer","usesLimitPerUser":"integer","singleUse":"boolean","productClasses":"<XLite\\Model\\ProductClass>[] array","memberships":"<XLite\\Model\\Membership>[] array","usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","categories":"<XLite\\Model\\Category>[] array"}],"featuredProducts":[{"id":"integer","orderBy":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>"}],"ogMeta":"example","useCustomOG":true,"productClasses":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","categories":"<XLite\\Model\\Category>[] array","id":"integer","position":"integer","attributes":"<XLite\\Model\\Attribute>[] array","attribute_groups":"<XLite\\Model\\AttributeGroup>[] array"}],"useClasses":"example","category_id":24,"lpos":23,"rpos":15,"enabled":false,"show_title":true,"depth":13,"pos":78,"root_category_look":"example","quickFlags":{"id":"integer","subcategories_count_all":"integer","subcategories_count_enabled":"integer","category":"<XLite\\Model\\Category>"},"memberships":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}],"image":{"category":"<XLite\\Model\\Category>","alt":"string","s3icons":"anything[] array","needMigration":"boolean","width":"integer","height":"integer","hash":"string","needProcess":"boolean","id":"integer","path":"string","fileName":"string","mime":"string","storageType":"string","size":"integer","date":"integer"},"banner":{"category":"<XLite\\Model\\Category>","alt":"string","s3icons":"anything[] array","needMigration":"boolean","width":"integer","height":"integer","hash":"string","needProcess":"boolean","id":"integer","path":"string","fileName":"string","mime":"string","storageType":"string","size":"integer","date":"integer"},"categoryProducts":[{"id":"integer","orderby":"integer","category":"<category object>","product":"<product object>"}],"children":["<XLite\\Model\\Category>"],"parent":"<XLite\\Model\\Category>","cleanURLs":[{"page":"<XLite\\Module\\CDev\\SimpleCMS\\Model\\Page>","newsMessage":"<XLite\\Module\\XC\\News\\Model\\NewsMessage>","id":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>","cleanURL":"string"}],"metaDescType":"example","xcPendingExport":false,"lastUsage":5}
coupons
Coupons
featuredProducts
Featured products (relation)
ogMeta
string
Custom Open graph meta tags
useCustomOG
boolean
User Open graph meta tags generator flag
demo
boolean
Flag, if the product participates in the sale
productClasses
Category classes
useClasses
string
Status code
category_id
integer
Node unique ID
lpos
integer
Node left value
rpos
integer
Node right value
enabled
boolean
Node status
show_title
boolean
Whether to display the category title, or not
depth
integer
Category "depth" in the tree
pos
integer
Category position parameter. Sort inside the parent category
root_category_look
string
Whether to display the category title, or not
quickFlags
memberships
Memberships
image
banner
categoryProducts
Relation to a CategoryProducts entities
children
Child categories
parent
cleanURLs
Clean URLs
metaDescType
string
Meta description type
xcPendingExport
boolean
Flag to exporting entities