Jump to

• Request
• Response

Get a Product

get

/rest/v18/products/{productId}

Use this endpoint to retrieve the specified CPQ product.

Request

Supported Media Types

• application/json

Path Parameters

• productId(required): string
  Uniquely identifies a Product

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Product Instance Definitions

Type: object

Title: Product Instance Definitions

Show Source

• bomItemVariableName: string
  Title: BOM Item Variable Name

  The variable name of the BOM item
• description: string
  Title: Description

  Description of the Product
• id: integer
  Title: Id

  Resource ID
• label: string
  Title: Label

  Product label
• listPrice: string
  Title: List Price

  List Price of the Product
• model: string
  Title: Model

  Name of the model
• modelPath: string
  Title: Model Path Variable Name

  Uniquely identifies a product mode
• partNumber: string
  Title: Part Number

  Part number of the Product
• productIdentifier: string
  Title: Product Identifier

  Uniquely identifies a Product
• productType: object Product Type
  Title: Product Type

  Type of The Product
• status: object Status
  Title: Status

  Workflow status of this product

{
    "type":"object",
    "properties":{
        "bomItemVariableName":{
            "type":"string",
            "description":"The variable name of the BOM item",
            "title":"BOM Item Variable Name"
        },
        "description":{
            "type":"string",
            "description":"Description of the Product",
            "title":"Description"
        },
        "id":{
            "type":"integer",
            "description":"Resource ID",
            "title":"Id"
        },
        "label":{
            "type":"string",
            "description":"Product label",
            "title":"Label"
        },
        "listPrice":{
            "type":"string",
            "description":"List Price of the Product",
            "title":"List Price"
        },
        "model":{
            "type":"string",
            "description":"Name of the model",
            "title":"Model"
        },
        "modelPath":{
            "type":"string",
            "description":"Uniquely identifies a product mode",
            "title":"Model Path Variable Name"
        },
        "partNumber":{
            "type":"string",
            "description":"Part number of the Product",
            "title":"Part Number"
        },
        "productIdentifier":{
            "type":"string",
            "description":"Uniquely identifies a Product",
            "title":"Product Identifier"
        },
        "productType":{
            "type":"object",
            "description":"Type of The Product",
            "title":"Product Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "status":{
            "type":"object",
            "description":"Workflow status of this product",
            "title":"Status",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        }
    },
    "title":"Product Instance Definitions"
}

Nested Schema : Product Type

Type: object

Title: Product Type

Type of The Product

Show Source

• displayValue: string
  Title: Display Value

  Translated display name of the type for which fixed list of values can be defined.
• id: integer
  Title: Id

  Primary Key of the fixed list of value resource.
• lookupCode: string
  Title: Lookup Code

  Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Type of The Product",
    "title":"Product Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : Status

Type: object

Title: Status

Workflow status of this product

Show Source

• displayValue: string
  Title: Display Value

  Translated display name of the type for which fixed list of values can be defined.
• id: integer
  Title: Id

  Primary Key of the fixed list of value resource.
• lookupCode: string
  Title: Lookup Code

  Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Workflow status of this product",
    "title":"Status",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Back to Top