API Version 2

• API V2 Overview

• Category

• Company

• Customers

• Orders

• Pages

• Page Templates

• Products

• Purchase Orders

• SKUs

• Support Tickets

• Tax Regions

• Vendors

• Warehouses

• warehouses/info
• warehouses/id
• warehouses
• vendors/update
• vendors/info_warehouse
• vendors/info_contact
• vendors/info
• vendors/id
• vendors/create
• vendors
• taxregions/update
• taxregions/info
• taxregions/create
• taxregions
• supporttickets/update
• supporttickets/info_comments
• supporttickets/info
• supporttickets/id
• supporttickets/create_comment
• supporttickets/create
• supporttickets
• skus/update
• skus/stock_level
• skus/info_batch
• skus/info
• skus/id
• skus/adjustment
• skus
• purchaseorders/update
• purchaseorders/info_receivement
• purchaseorders/info_product
• purchaseorders/info
• purchaseorders/create_receivement
• PurchaseOrders/create
• PurchaseOrders
• products/update
• products/info_sku
• products/info_page
• products/info_image
• products/info
• products/id
• products/create
• products
• pagetemplates/update
• pagetemplates/info
• pagetemplates/create
• pagetemplates
• pages/update
• pages/redirect
• pages/info
• pages/create_redirect
• pages/create
• pages
• orders/update_fulfillment
• orders/update
• orders/info_shipping
• orders/info_returns
• orders/info_product
• orders/info_payments
• orders/info_fulfillments
• orders/info
• orders/id
• orders/fulfillment
• orders/create
• orders
• customers/update
• customers/info_login
• customers/info_address
• customers/info
• customers/id
• customers/create
• customers
• companies/update
• companies/info
• companies/create
• companies
• category/update
• category/info_tree
• category/info_page
• category/info
• category/create
• category

API Documentation

• Overview
• API V2
• API V1

Type	List
List	Category
URL	http://{domain}/api/v2/categories.json
Accepts Filters	Yes
Output Attributes	No

List Categories or Subcategories

Gets the filtered list of categories or subcategories.

Filters

Filter the categories into a list. Category Attributes are available as a filter.

Parameter	Type	Rules	Example
status	int	0,1 or 2	1
subcategory	boolean	Category a subcategory or not	false
slug	string	Associated slug value	pants_men
name	string	Associated name value	Men Pants
modify_start	date		1431377356
modify_end	date		1431377356

Pagination

Parameters can be added to the CURL call to paginate the List. The maximum limit is 250. By default, this limit is set to 100.

Parameter	Type	Default	Example
limit	int	1	2
page	int	1	5

Response

Example category JSON returned

{
  "code": "200",
  "data": [
    {
      "id": "1",
      "name": "Products",
      "slug": "products",
      "status": "1"
    },
    {
      "id": "2",
      "name": "Sale Items",
      "slug": "sale_items",
      "status": "1"
    }
  ]
}

Example subcategory JSON returned

{
  "code": "200",
  "data": [
    {
      "id": "1",
      "name": "Men Shirts",
      "slug": "shirts_men",
      "status": "1"
    },
    {
      "id": "2",
      "name": "Women Shirts",
      "slug": "shirts_women",
      "status": "1"
    },
    {
      "id": "3",
      "name": "Women Pants",
      "slug": "pants_women",
      "status": "1"
    },
    {
      "id": "4",
      "name": "Men Pants",
      "slug": "pants_men",
      "status": "1"
    },
    {
      "id": "5",
      "name": "Women",
      "slug": "women",
      "status": "1"
    },
    {
      "id": "6",
      "name": "Men",
      "slug": "men",
      "status": "1"
    },
    {
      "id": "7",
      "name": "Bikes",
      "slug": "bikes",
      "status": "1"
    }
  ]
}