MyCloud Logo

MyCloud API Documentation

ProductCategory Model [read-only]

The ProductCategory model represents a product category used for organizing your products.

RESTful Calls

Get All ProductCategories

GET/productcategories

Get all product categories associated with your account.

Request Parameters

This request has no parameters.

Response

Name
Type
Example
Description
productcategories
productcategory[]
The list of product categories attached to your account.
productcategory
Object
 
A productcategory object.
id
integer
342
This is the product category's database key.
code
string
CAT0304
This is a MyCloud assigned code for this product category. This code cannot be changed.
name
string
T-Shirts
The name of this product category as assigned by the shop.

Get ProductCategory

GET/productcategories/{category_id}

Get a product category by it's ID.

Request Parameters

Parameter
Type
Required
Example
Description
category_id
integer
Yes
1287
The database ID that identifies this product category.

Response

Name
Type
Example
Description
productcategory
Object
 
A productcategory object.
id
integer
342
This is the product category's database key.
code
string
CAT0304
This is a MyCloud assigned code for this product category. This code cannot be changed.
name
string
T-Shirts
The name of this product category as assigned by the shop.

Create ProductCategory

POST/productcategories

Create a new product category with the specified attributes.

Request Parameters

Parameter
Type
Required
Example
Description
name
string
Yes
T-Shirts
The name of this product category.

Response

This request has no returned data.