API

RamBase REST APIs

GET product/classifications/{classificationId}

Details for provided product classification identifier. See the parent product classifications by expanding "ParentProductionClassifications"

HTTP method GET
URI https://api.rambase.net/product/classifications/{classificationId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {classificationId} Product classification identifier
String, minimum 2
Successful HTTP status code 200
API resource identifier 1743, version 6

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<ProductClassification>
2
     <ProductClassificationId
ProductClassificationId

Product classification identifier

>{String}</ProductClassificationId>
3
     <Status
Status

Status of product classification

>{Integer}</Status>
4
     <TreeLevel
TreeLevel

Level in product classification tree (0 is root)

>{Integer}</TreeLevel>
5
     <Name
Name

Name of product classification

>{String}</Name>
6
     <SortingPriority
SortingPriority

Sorting priority of the product classification.

>{Decimal}</SortingPriority>
7
     <ProductCount
ProductCount

Number of products in status less than 9 in this product classification, including all child classifications (all tree levels).

This field is greyed out because it is an expandable field. You have to add $expand=ProductCount in your request URI to get this field

>{Long}</ProductCount>
8
     <ParentProductClassifications
ParentProductClassifications

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

>
9
          <ProductClassification
ProductClassification

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

>
10
               <ProductClassificationId
ProductClassificationId

Product classification identifier

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

>{String}</ProductClassificationId>
11
               <TreeLevel
TreeLevel

Level in product classification tree (0 is root)

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

>{Integer}</TreeLevel>
12
               <Name
Name

Name of product classification

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

>{String}</Name>
13
               <ProductClassificationLink
ProductClassificationLink

Product classification reference

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

>{String}</ProductClassificationLink>
14
          </ProductClassification>
15
     </ParentProductClassifications>
16
</ProductClassification>
1
{
2
     "productClassification": {
3
          "productClassificationId
ProductClassificationId

Product classification identifier

": "{String}",
4
          "status
Status

Status of product classification

": "{Integer}",
5
          "treeLevel
TreeLevel

Level in product classification tree (0 is root)

": "{Integer}",
6
          "name
Name

Name of product classification

": "{String}",
7
          "sortingPriority
SortingPriority

Sorting priority of the product classification.

": "{Decimal}",
8
          "productCount
ProductCount

Number of products in status less than 9 in this product classification, including all child classifications (all tree levels).

This field is greyed out because it is an expandable field. You have to add $expand=ProductCount in your request URI to get this field

": "{Long}",
9
          "parentProductClassifications
ParentProductClassifications

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

": [
10
               {
11
                    "productClassificationId
ProductClassificationId

Product classification identifier

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

": "{String}",
12
                    "treeLevel
TreeLevel

Level in product classification tree (0 is root)

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

": "{Integer}",
13
                    "name
Name

Name of product classification

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

": "{String}",
14
                    "productClassificationLink
ProductClassificationLink

Product classification reference

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

": "{String}"
15
               }
16
          ]
17
     }
18
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100027 HTTP 400 Missing mandatory parameter {0}