GET products/configuration/families/show

Available from CRM.COM R14.0.0

This method returns information related with a product family. A single product family is returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

family_identifier

(mandatory)

Product Family Identifier

The identifier of the product family. The allowed product family identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product family

name

(semi-optional)

String

The name of the product family

code

(semi-optional)

String

The code of a product family

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified

Response Data

Name	Type	Description
id	String	The ID of the retrieved product family
name	String	The Name of the retrieved product family
code	String	The code of the retrieved product family
description	String	The Description of the retrieved product family
parent	Product Family Object	The retrieved product families

Referred Objects Response Data

product_family object data response

Name	Type	Description
Id	String	The ID of the retrieved product family
name	String	The Name of the retrieved product family
code	String	The code of the retrieved product family
description	String	The Description of the retrieved product family

Examples

Example 1

HTTP Method: GET

Request:

Response:

 {
    "data": {
        "parent": {
            "code": "D",
            "name": "Decoders",
            "description": null,
            "id": "5149B4514E63446FA6364CE445A265CF"
        },
        "code": "Use Dec",
        "name": "Usage Decoder",
        "description": null,
        "id": "F5681BD5DF7445249499AC67C852F904"
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}