ItemExtend

MxCategories

Read-only endpoint for MXCategory information. MXCategory resources describe a nestable set of categories which can be associated with a set of StockItems for grouping purposes.

Fields

url

  • Type: Url

Link to the MxCategory

id

  • Type: Number Primary Key of the MxCategory

name

  • Type: String

Name of the MxCategory

  • Type: String

SEO Slug for the MxCategory

description

  • Type: HTML String

MxCategory Description

product_type

  • Type: String

It's something?

brand

  • Type: object
  • Fields
    • name - name of the brand
    • catalog_description - Description of the brand

items_count

  • Type: Number Number of StockItems in this MxCategory

subcategories_count

  • Type: Number Number of MxCategories in this MxCategory

items

subcategories

  • Type: Url link to subcategories of the MxCategories

linked_images

list of image objects linked to this mxcategory

example image object:

{
    "order": 0,
    "image": {
        "name": "101mw-oneway-register_1_600X600.jpg",
        "alt_text": "",
        "zoom": "http://s3.amazonaws.com/assets.itemextend.com/jedco/media/images/101mw-oneway-register_1_600X600_20180202201218.jpg",
        "large": "http://s3.amazonaws.com/assets.itemextend.com/jedco/media/CACHE/images/images/101mw-oneway-register_1_600X600_20180202201218/4dd3a475a41976690b47129b354663b0.png",
        "medium": "http://s3.amazonaws.com/assets.itemextend.com/jedco/media/CACHE/images/images/101mw-oneway-register_1_600X600_20180202201218/40643423c0c79f4649dfd2b2bce59010.png",
        "thumbnail": "http://s3.amazonaws.com/assets.itemextend.com/jedco/media/CACHE/images/images/101mw-oneway-register_1_600X600_20180202201218/50a7369ce9c1bd13b17760a1e8ba2195.png",
        "mini": "http://s3.amazonaws.com/assets.itemextend.com/jedco/media/CACHE/images/images/101mw-oneway-register_1_600X600_20180202201218/b648c19889be917fbb13602d78c6a226.png",
        "attributes": []
    }
}

linked_videos

list of linked videos

linked_documents

list of linked documents

example of document:

{
    "order": 2,
    "document": {
        "name": "101M Submittal",
        "file": "http://s3.amazonaws.com/assets.itemextend.com/jedco/media/documents/101Mspecta.pdf",
        "type": "PDF",
        "attributes": [
            {
                "name": "product_page_tab",
                "title": "Product Page Tab",
                "value": "Submittals"
            }
        ]
    }
}

Endpoints

List

GET /api/mxcategories/

Return a paginated list of MXCategories. Can be filtered by name or seo_link.

Retrieve

GET /api/mxcategories/:key/

GET /api/mxcategories/:seo_link/

Return an individual MXCategory by primary key or seo_link.

List Subcategories

GET /api/mxcategories/:key/subcategories/

GET /api/mxcategories/:seo_link/subcategories/

Return a paginated list of Subcategories of an MXCategory by primary key or seo_link.

List Items

GET /api/mxcategories/:key/items/

GET /api/mxcategories/:seo_link/items/

Return a paginated list of StockItems of an MXCategory by primary key or seo_link.

← Orders →