THE API BASICS
Catalog Administration API
Description: Catalog management processes. Requires administrator to be signed in.
Default URL: https://your-site.com/api/admin/catalog
Response/return: Cart Boxx APIs will always return a standard response, most data will be put into the “cb-more” response field – Check out function verbose in the library reference.
Example Usage
$.ajax({
url : "https://your-site.com/api/admin/catalog",
data : {
req : "del-cat",
catagory_id : 999
}
}).done(
// DO YOUR PROCESSING HERE
);
CATEGORY RELATED
req: add-cat
Description: Add new category
Parameters
[STRING] $_POST[‘category_name’] – Category name.
[STRING] $_POST[‘category_slug’] – Category slug.
[STRING] $_POST[‘category_description’] – Category description.
[STRING] $_POST[‘category_image’] – Category image.
[STRING] $_POST[‘category_slug’] – Category slug.
[STRING] $_POST[‘category_description’] – Category description.
[STRING] $_POST[‘category_image’] – Category image.
req: edit-cat
Description: Update category
Parameters
[INT] $_POST[‘category_id’] – Category ID
[STRING] $_POST[‘category_name’] – Category name.
[STRING] $_POST[‘category_slug’] – Category slug.
[STRING] $_POST[‘category_description’] – Category description.
[STRING] $_POST[‘category_image’] – Category image.
[STRING] $_POST[‘category_name’] – Category name.
[STRING] $_POST[‘category_slug’] – Category slug.
[STRING] $_POST[‘category_description’] – Category description.
[STRING] $_POST[‘category_image’] – Category image.
req: del-cat
Description: Delete category
Parameters
[INT] $_POST[‘category_id’] – Category ID
PRODUCTS RELATED
req: add-pdt
Description: Add new product
Parameters
[STRING] $_POST[‘product_name’] – Product name
[STRING] $_POST[‘product_slug’] – Product slug
[STRING] $_POST[‘product_description’] – Product description
[STRING] $_POST[‘product_image’] – Product image
[DECIMAL] $_POST[‘product_price’] – Product price
[STRING] $_POST[‘product_slug’] – Product slug
[STRING] $_POST[‘product_description’] – Product description
[STRING] $_POST[‘product_image’] – Product image
[DECIMAL] $_POST[‘product_price’] – Product price
req: edit-pdt
Description: Edit product
Parameters
[INT] $_POST[‘product_id’] – Product ID
[STRING] $_POST[‘product_name’] – Product name
[STRING] $_POST[‘product_slug’] – Product slug
[STRING] $_POST[‘product_description’] – Product description
[STRING] $_POST[‘product_image’] – Product image
[DECIMAL] $_POST[‘product_price’] – Product price
[STRING] $_POST[‘product_name’] – Product name
[STRING] $_POST[‘product_slug’] – Product slug
[STRING] $_POST[‘product_description’] – Product description
[STRING] $_POST[‘product_image’] – Product image
[DECIMAL] $_POST[‘product_price’] – Product price
req: del-pdt
Description: Delete product
Parameters
[INT] $_POST[‘product_id’] – Product ID
ASSIGNMENT RELATED
req: add-pdt-to-cat
Description: Add products to categories
Parameters
[ARRAY] $_POST[‘p2c’] – Products to categories, in the format of [PRODUCT ID => [CATEGORY ID, CATEGORY ID], PRODUCT ID => [CATEGORY ID, CATEGORY ID]]
req: del-pdt-to-cat
Description: Remove products from categories
Parameters
[ARRAY] $_POST[‘p2c’] – Products to categories, in the format of [PRODUCT ID => [CATEGORY ID, CATEGORY ID], PRODUCT ID => [CATEGORY ID, CATEGORY ID]]
