Jump to

• Request
• Response

Get an All Product Families Catalog Definition

get

/rest/v16/allProductFamilySetups/{varName}

Use this endpoint to retrieve a catalog definition for the specified All Product Families item.

Request

Supported Media Types

• application/json

Path Parameters

• varName(required): string
  Variable Name of All Product Families '_allProductFamilies'

Query Parameters

• expand: string
  Allows expansion of relationships.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Product

Type: object

Title: Product

Show Source

• companyId: integer
  Title: Company Id

  Company Id
• label: string
  Title: Label

  Label
• variableName: string
  Title: Variable Name of All Product Families '_allProductFamilies'

  Variable Name of All Product Families '_allProductFamilies'

{
    "type":"object",
    "properties":{
        "companyId":{
            "type":"integer",
            "description":"Company Id",
            "title":"Company Id"
        },
        "label":{
            "type":"string",
            "description":"Label",
            "title":"Label"
        },
        "variableName":{
            "type":"string",
            "description":"Variable Name of All Product Families '_allProductFamilies'",
            "title":"Variable Name of All Product Families '_allProductFamilies'"
        }
    },
    "title":"Product"
}

Back to Top