Response [200 Ok]
| Uri | /api/v2/catalog/vendor/BayPhoto/category/desk |
|---|---|
| UriDescription | Catalog Category by ID |
| EndpointType | CatalogCategory |
| Locator | CatalogCategory |
| LocatorType | Object |
CatalogCategory [1 of 1]
- Desk Art
/api/v2/catalog/vendor/BayPhoto/category/desk
| Uri | /api/v2/catalog/vendor/BayPhoto/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/BayPhoto/category/desk!subcategories
| Uri | /api/v2/catalog/vendor/BayPhoto/category/desk!subcategories |
|---|---|
| UriDescription | List Catalog Sub Categories |
| EndpointType | CatalogSubCategories |
| Locator | CatalogSubCategory |
| LocatorType | Objects |
CatalogVendor
/api/v2/catalog/vendor/BayPhoto
| Uri | /api/v2/catalog/vendor/BayPhoto |
|---|---|
| UriDescription | Catalog Vendor by ID |
| EndpointType | CatalogVendor |
| Locator | CatalogVendor |
| LocatorType | Object |
Request
| Uri | /api/v2/catalog/vendor/BayPhoto/category/desk |
|---|---|
| Method | GET |
| Version | v2 |
Config
{
"expand_method": "ref",
"shorturis": false
}
Options
Methods
OPTIONS
| Permissions |
|
|---|
GET
| Permissions |
|
|---|
Output Fields
| Description | text | |
|---|---|---|
| Name | text | |
| SortIndex | integer |
JSON
{
"Request": {
"Version": "v2",
"Method": "GET",
"Uri": "/api/v2/catalog/vendor/BayPhoto/category/desk"
},
"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"
],
"Output": [
{
"Name": "Description",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
},
{
"Name": "Name",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
},
{
"Name": "SortIndex",
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
}
],
"Path": [
{
"type": "path",
"text": "api"
},
{
"type": "path",
"text": "v2"
},
{
"type": "path",
"text": "catalog"
},
{
"type": "path",
"text": "vendor"
},
{
"type": "singleparam",
"param_name": "vendorId",
"param_value": "BayPhoto",
"param_validator": {}
},
{
"type": "path",
"text": "category"
},
{
"type": "singleparam",
"param_name": "categoryId",
"param_value": "desk",
"param_validator": {}
}
]
},
"Response": {
"Uri": "/api/v2/catalog/vendor/BayPhoto/category/desk",
"Locator": "CatalogCategory",
"LocatorType": "Object",
"CatalogCategory": {
"Description": "Finished photo mounts for your desk",
"Name": "Desk Art",
"SortIndex": 5,
"Uri": "/api/v2/catalog/vendor/BayPhoto/category/desk",
"UriDescription": "Catalog Category by ID",
"Uris": {
"CatalogVendor": {
"Uri": "/api/v2/catalog/vendor/BayPhoto",
"Locator": "CatalogVendor",
"LocatorType": "Object",
"UriDescription": "Catalog Vendor by ID",
"EndpointType": "CatalogVendor"
},
"CatalogSubCategories": {
"Uri": "/api/v2/catalog/vendor/BayPhoto/category/desk!subcategories",
"Locator": "CatalogSubCategory",
"LocatorType": "Objects",
"UriDescription": "List Catalog Sub Categories",
"EndpointType": "CatalogSubCategories"
}
}
},
"UriDescription": "Catalog Category by ID",
"EndpointType": "CatalogCategory",
"Timing": {
"Total": {
"time": 0.0382,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}