Response [200 Ok]

Uri /api/v2/catalog/vendor/WHCC!categories
UriDescription List Catalog Categories
EndpointType CatalogCategories
Locator CatalogCategory
LocatorType Objects

CatalogCategory [1 of 5] - Wall Art
/api/v2/catalog/vendor/WHCC/category/wall

Uri /api/v2/catalog/vendor/WHCC/category/wall
UriDescription Catalog Category by ID
Description Gorgeous products ready to hang
Name Wall Art
SortIndex 4

Uris

CatalogSubCategories
/api/v2/catalog/vendor/WHCC/category/wall!subcategories

Uri /api/v2/catalog/vendor/WHCC/category/wall!subcategories
UriDescription List Catalog Sub Categories
EndpointType CatalogSubCategories
Locator CatalogSubCategory
LocatorType Objects

CatalogVendor
/api/v2/catalog/vendor/WHCC

Uri /api/v2/catalog/vendor/WHCC
UriDescription Catalog Vendor by ID
EndpointType CatalogVendor
Locator CatalogVendor
LocatorType Object

CatalogCategory [2 of 5] - Desk Art
/api/v2/catalog/vendor/WHCC/category/desk

Uri /api/v2/catalog/vendor/WHCC/category/desk
UriDescription Catalog Category by ID
Description Finished photo mounts for your desk
Name Desk Art
SortIndex 5

Uris

CatalogSubCategories
/api/v2/catalog/vendor/WHCC/category/desk!subcategories

Uri /api/v2/catalog/vendor/WHCC/category/desk!subcategories
UriDescription List Catalog Sub Categories
EndpointType CatalogSubCategories
Locator CatalogSubCategory
LocatorType Objects

CatalogVendor
/api/v2/catalog/vendor/WHCC

Uri /api/v2/catalog/vendor/WHCC
UriDescription Catalog Vendor by ID
EndpointType CatalogVendor
Locator CatalogVendor
LocatorType Object

CatalogCategory [3 of 5] - Paper Prints
/api/v2/catalog/vendor/WHCC/category/prints

Uri /api/v2/catalog/vendor/WHCC/category/prints
UriDescription Catalog Category by ID
Description Prints on high quality paper
Name Paper Prints
SortIndex 2

Uris

CatalogSubCategories
/api/v2/catalog/vendor/WHCC/category/prints!subcategories

Uri /api/v2/catalog/vendor/WHCC/category/prints!subcategories
UriDescription List Catalog Sub Categories
EndpointType CatalogSubCategories
Locator CatalogSubCategory
LocatorType Objects

CatalogVendor
/api/v2/catalog/vendor/WHCC

Uri /api/v2/catalog/vendor/WHCC
UriDescription Catalog Vendor by ID
EndpointType CatalogVendor
Locator CatalogVendor
LocatorType Object

CatalogCategory [4 of 5] - Albums
/api/v2/catalog/vendor/WHCC/category/albums

Uri /api/v2/catalog/vendor/WHCC/category/albums
UriDescription Catalog Category by ID
Description High quality professional albums designed by your customers
Name Albums
SortIndex 98

Uris

CatalogSubCategories
/api/v2/catalog/vendor/WHCC/category/albums!subcategories

Uri /api/v2/catalog/vendor/WHCC/category/albums!subcategories
UriDescription List Catalog Sub Categories
EndpointType CatalogSubCategories
Locator CatalogSubCategory
LocatorType Objects

CatalogVendor
/api/v2/catalog/vendor/WHCC

Uri /api/v2/catalog/vendor/WHCC
UriDescription Catalog Vendor by ID
EndpointType CatalogVendor
Locator CatalogVendor
LocatorType Object

CatalogCategory [5 of 5] - Greeting Cards
/api/v2/catalog/vendor/WHCC/category/cards

Uri /api/v2/catalog/vendor/WHCC/category/cards
UriDescription Catalog Category by ID
Description Create custom press printed greeting cards
Name Greeting Cards
SortIndex 99

Uris

CatalogSubCategories
/api/v2/catalog/vendor/WHCC/category/cards!subcategories

Uri /api/v2/catalog/vendor/WHCC/category/cards!subcategories
UriDescription List Catalog Sub Categories
EndpointType CatalogSubCategories
Locator CatalogSubCategory
LocatorType Objects

CatalogVendor
/api/v2/catalog/vendor/WHCC

Uri /api/v2/catalog/vendor/WHCC
UriDescription Catalog Vendor by ID
EndpointType CatalogVendor
Locator CatalogVendor
LocatorType Object

Timing

Total

cycles 1
objects 0
time 0.01416

Config

{
    "expand_method": "ref",
    "shorturis": false
}

Options

Path

  • /api
  • /v2
  • /catalog
  • /vendor
  • /
  • !categories

Notes

  • _multiargs does not work at this endpoint

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/catalog/vendor/WHCC!categories"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Notes": [
            "_multiargs does not work at this endpoint"
        ],
        "Path": [
            {
                "type": "path",
                "text": "api"
            },
            {
                "type": "path",
                "text": "v2"
            },
            {
                "type": "path",
                "text": "catalog"
            },
            {
                "type": "path",
                "text": "vendor"
            },
            {
                "type": "singleparam",
                "param_name": "vendorId",
                "param_value": "WHCC",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "categories"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/catalog/vendor/WHCC!categories",
        "Locator": "CatalogCategory",
        "LocatorType": "Objects",
        "CatalogCategory": [
            {
                "Description": "Gorgeous products ready to hang",
                "Name": "Wall Art",
                "SortIndex": 4,
                "Uri": "/api/v2/catalog/vendor/WHCC/category/wall",
                "UriDescription": "Catalog Category by ID",
                "Uris": {
                    "CatalogVendor": {
                        "Uri": "/api/v2/catalog/vendor/WHCC",
                        "Locator": "CatalogVendor",
                        "LocatorType": "Object",
                        "UriDescription": "Catalog Vendor by ID",
                        "EndpointType": "CatalogVendor"
                    },
                    "CatalogSubCategories": {
                        "Uri": "/api/v2/catalog/vendor/WHCC/category/wall!subcategories",
                        "Locator": "CatalogSubCategory",
                        "LocatorType": "Objects",
                        "UriDescription": "List Catalog Sub Categories",
                        "EndpointType": "CatalogSubCategories"
                    }
                }
            },
            {
                "Description": "Finished photo mounts for your desk",
                "Name": "Desk Art",
                "SortIndex": 5,
                "Uri": "/api/v2/catalog/vendor/WHCC/category/desk",
                "UriDescription": "Catalog Category by ID",
                "Uris": {
                    "CatalogVendor": {
                        "Uri": "/api/v2/catalog/vendor/WHCC",
                        "Locator": "CatalogVendor",
                        "LocatorType": "Object",
                        "UriDescription": "Catalog Vendor by ID",
                        "EndpointType": "CatalogVendor"
                    },
                    "CatalogSubCategories": {
                        "Uri": "/api/v2/catalog/vendor/WHCC/category/desk!subcategories",
                        "Locator": "CatalogSubCategory",
                        "LocatorType": "Objects",
                        "UriDescription": "List Catalog Sub Categories",
                        "EndpointType": "CatalogSubCategories"
                    }
                }
            },
            {
                "Description": "Prints on high quality paper",
                "Name": "Paper Prints",
                "SortIndex": 2,
                "Uri": "/api/v2/catalog/vendor/WHCC/category/prints",
                "UriDescription": "Catalog Category by ID",
                "Uris": {
                    "CatalogVendor": {
                        "Uri": "/api/v2/catalog/vendor/WHCC",
                        "Locator": "CatalogVendor",
                        "LocatorType": "Object",
                        "UriDescription": "Catalog Vendor by ID",
                        "EndpointType": "CatalogVendor"
                    },
                    "CatalogSubCategories": {
                        "Uri": "/api/v2/catalog/vendor/WHCC/category/prints!subcategories",
                        "Locator": "CatalogSubCategory",
                        "LocatorType": "Objects",
                        "UriDescription": "List Catalog Sub Categories",
                        "EndpointType": "CatalogSubCategories"
                    }
                }
            },
            {
                "Description": "High quality professional albums designed by your customers",
                "Name": "Albums",
                "SortIndex": 98,
                "Uri": "/api/v2/catalog/vendor/WHCC/category/albums",
                "UriDescription": "Catalog Category by ID",
                "Uris": {
                    "CatalogVendor": {
                        "Uri": "/api/v2/catalog/vendor/WHCC",
                        "Locator": "CatalogVendor",
                        "LocatorType": "Object",
                        "UriDescription": "Catalog Vendor by ID",
                        "EndpointType": "CatalogVendor"
                    },
                    "CatalogSubCategories": {
                        "Uri": "/api/v2/catalog/vendor/WHCC/category/albums!subcategories",
                        "Locator": "CatalogSubCategory",
                        "LocatorType": "Objects",
                        "UriDescription": "List Catalog Sub Categories",
                        "EndpointType": "CatalogSubCategories"
                    }
                }
            },
            {
                "Description": "Create custom press printed greeting cards",
                "Name": "Greeting Cards",
                "SortIndex": 99,
                "Uri": "/api/v2/catalog/vendor/WHCC/category/cards",
                "UriDescription": "Catalog Category by ID",
                "Uris": {
                    "CatalogVendor": {
                        "Uri": "/api/v2/catalog/vendor/WHCC",
                        "Locator": "CatalogVendor",
                        "LocatorType": "Object",
                        "UriDescription": "Catalog Vendor by ID",
                        "EndpointType": "CatalogVendor"
                    },
                    "CatalogSubCategories": {
                        "Uri": "/api/v2/catalog/vendor/WHCC/category/cards!subcategories",
                        "Locator": "CatalogSubCategory",
                        "LocatorType": "Objects",
                        "UriDescription": "List Catalog Sub Categories",
                        "EndpointType": "CatalogSubCategories"
                    }
                }
            }
        ],
        "UriDescription": "List Catalog Categories",
        "EndpointType": "CatalogCategories",
        "Timing": {
            "Total": {
                "time": 0.01416,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}