Jump to

• Request
• Response

Search for Products

post

/rest/v18/products/actions/search

Use this endpoint to filter CPQ products using the specified search criteria.

Request

Supported Media Types

• application/json

Body ()

Root Schema : Product Search Collection Request Definitions

Type: object

Title: Product Search Collection Request Definitions

Show Source

• context: object Product Search Context
  Title: Product Search Context

  Context definition for product search.
• criteria: object Query Definition
  Title: Query Definition

  Captures the query definition for the current resource request.

{
    "type":"object",
    "properties":{
        "criteria":{
            "$ref":"#/definitions/queryDef"
        },
        "context":{
            "$ref":"#/definitions/productsSearchContext"
        }
    },
    "title":"Product Search Collection Request Definitions"
}

Nested Schema : Product Search Context

Type: object

Title: Product Search Context

Context definition for product search.

Show Source

• commerce: object Commerce Data
  Title: Commerce Data

  Transaction data for products search.
• pricebookVarName: string
  Title: Pricebook Variable Name

  String value that specifies the variable Name of the pricebook.

{
    "type":"object",
    "properties":{
        "pricebookVarName":{
            "type":"string",
            "description":"String value that specifies the variable Name of the pricebook.",
            "title":"Pricebook Variable Name"
        },
        "commerce":{
            "type":"object",
            "description":"Transaction data for products search.",
            "title":"Commerce Data",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Current Unique Buyside ID of the transaction.",
                    "title":"Transaction Id"
                },
                "cacheInstanceId":{
                    "type":"string",
                    "description":"The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action to avoid reload transaction data from db.",
                    "title":"Cache Instance Id"
                },
                "process":{
                    "type":"object",
                    "description":"The transaction's process meta-data.",
                    "title":"Process",
                    "properties":{
                        "variableName":{
                            "type":"string",
                            "description":"The variable name of the process that the current transaction data belongs to.",
                            "title":"Process Variable Name"
                        }
                    }
                },
                "currencyCode":{
                    "type":"string",
                    "description":"The currencyCode value in which the attribute is represented",
                    "title":"Currency Code"
                },
                "mainDocument":{
                    "type":"object",
                    "description":"The transaction's main document data.",
                    "title":"Main Document Data",
                    "properties":{
                        "variableName":{
                            "type":"string",
                            "description":"The variable name of the main document that the current transaction data belongs to.",
                            "title":"Main Document Variable Name"
                        },
                        "attributes":{
                            "$ref":"#/definitions/attributesDef"
                        }
                    }
                }
            }
        }
    },
    "title":"Product Search Context",
    "description":"Context definition for product search."
}

Nested Schema : Query Definition

Type: object

Title: Query Definition

Captures the query definition for the current resource request.

Show Source

• actions: array actions
  Array of actions names, whose state is requested in the state object response.
• childDefs: array childDefs
• enableHierarchy: boolean
  Parameter value should be true to execute hierarchy search and sort. Default value is false.
• excludeFieldTypes: array excludeFieldTypes
  Array of field names that you want to exclude in the response.
• expand: array expand
  Array of child resource names that you want to expand so that the contents return with the parent in the same request.
• expandedDomainCriteria: array expandedDomainCriteria
  Map of dynamic menu field names, whose expanded domains are requested in the state object response, to a map of criteria, which are meant for filtering dynamic menu options. The criteria map should contain the node(s) information when dynamic menus on LIG are expanded. The criteria map also contains the search string. The search strings support contains, and are case-insensitive.
• expandedDomains: array expandedDomains
  Array of field names, whose expanded domains are requested in the state object response.
• expandNodes: boolean
  Boolean value that only be available when enableHierarchy is true. True = all nodes will be expanded; False = All nodes will be collapsed.Default value is true.
• fields: array fields
  Array of field names that you wanted returned in a request.
• groups: array groups
  Array of group names, whose state is requested in the state object response.
• limit: integer
  Positive integer value that specifies the maximum number of items returned by the server.
• nodesExceptionList: array nodesExceptionList
  Array of document_number, recording the nodes that violate current expandNodes flag
• offset: integer
  Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
• orderBy: array orderBy
  Array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
• q: string
  Filter (a ???where???clause) to restrict the items returned in the collection. By default, no filtering is applied.
• state: boolean
  Boolean value that specifies whether to calculate the state property. By default, this value is set to false indicating that state is not calculated.
• totalResults: boolean
  Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"boolean",
            "description":"Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated."
        },
        "q":{
            "type":"string",
            "description":"Filter (a ???where???clause) to restrict the items returned in the collection. By default, no filtering is applied."
        },
        "limit":{
            "type":"integer",
            "description":"Positive integer value that specifies the maximum number of items returned by the server."
        },
        "offset":{
            "type":"integer",
            "description":"Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection."
        },
        "state":{
            "type":"boolean",
            "description":"Boolean value that specifies whether to calculate the state property. By default, this value is set to false indicating that state is not calculated."
        },
        "orderBy":{
            "type":"array",
            "description":"Array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.",
            "items":{
                "type":"string"
            }
        },
        "expand":{
            "type":"array",
            "description":"Array of child resource names that you want to expand so that the contents return with the parent in the same request.",
            "items":{
                "type":"string"
            }
        },
        "fields":{
            "type":"array",
            "description":"Array of field names that you wanted returned in a request.",
            "items":{
                "type":"string"
            }
        },
        "excludeFieldTypes":{
            "type":"array",
            "description":"Array of field names that you want to exclude in the response.",
            "items":{
                "type":"string"
            }
        },
        "actions":{
            "type":"array",
            "description":"Array of actions names, whose state is requested in the state object response.",
            "items":{
                "type":"string"
            }
        },
        "groups":{
            "type":"array",
            "description":"Array of group names, whose state is requested in the state object response.",
            "items":{
                "type":"string"
            }
        },
        "expandedDomains":{
            "type":"array",
            "description":"Array of field names, whose expanded domains are requested in the state object response.",
            "items":{
                "type":"string"
            }
        },
        "childDefs":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/childQueryDef"
            }
        },
        "enableHierarchy":{
            "type":"boolean",
            "description":"Parameter value should be true to execute hierarchy search and sort. Default value is false."
        },
        "expandNodes":{
            "type":"boolean",
            "description":"Boolean value that only be available when enableHierarchy is true. True = all nodes will be expanded; False = All nodes will be collapsed.Default value is true."
        },
        "nodesExceptionList":{
            "type":"array",
            "description":"Array of document_number, recording the nodes that violate current expandNodes flag",
            "items":{
                "type":"string"
            }
        },
        "expandedDomainCriteria":{
            "type":"array",
            "description":"Map of dynamic menu field names, whose expanded domains are requested in the state object response, to a map of criteria, which are meant for filtering dynamic menu options. The criteria map should contain the node(s) information when dynamic menus on LIG are expanded. The criteria map also contains the search string. The search strings support contains, and are case-insensitive.",
            "items":{
                "type":"string"
            }
        }
    },
    "title":"Query Definition",
    "description":"Captures the query definition for the current resource request."
}

Nested Schema : Commerce Data

Type: object

Title: Commerce Data

Transaction data for products search.

Show Source

• cacheInstanceId: string
  Title: Cache Instance Id

  The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action to avoid reload transaction data from db.
• currencyCode: string
  Title: Currency Code

  The currencyCode value in which the attribute is represented
• id: string
  Title: Transaction Id

  Current Unique Buyside ID of the transaction.
• mainDocument: object Main Document Data
  Title: Main Document Data

  The transaction's main document data.
• process: object Process
  Title: Process

  The transaction's process meta-data.

{
    "type":"object",
    "description":"Transaction data for products search.",
    "title":"Commerce Data",
    "properties":{
        "id":{
            "type":"string",
            "description":"Current Unique Buyside ID of the transaction.",
            "title":"Transaction Id"
        },
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action to avoid reload transaction data from db.",
            "title":"Cache Instance Id"
        },
        "process":{
            "type":"object",
            "description":"The transaction's process meta-data.",
            "title":"Process",
            "properties":{
                "variableName":{
                    "type":"string",
                    "description":"The variable name of the process that the current transaction data belongs to.",
                    "title":"Process Variable Name"
                }
            }
        },
        "currencyCode":{
            "type":"string",
            "description":"The currencyCode value in which the attribute is represented",
            "title":"Currency Code"
        },
        "mainDocument":{
            "type":"object",
            "description":"The transaction's main document data.",
            "title":"Main Document Data",
            "properties":{
                "variableName":{
                    "type":"string",
                    "description":"The variable name of the main document that the current transaction data belongs to.",
                    "title":"Main Document Variable Name"
                },
                "attributes":{
                    "$ref":"#/definitions/attributesDef"
                }
            }
        }
    }
}

Nested Schema : Main Document Data

Type: object

Title: Main Document Data

The transaction's main document data.

Show Source

• attributes: object Attributes
  Title: Attributes

  A set of key, value pairs with key being attribute's variableName and value being the value of the attribute.If its an msm, it can take list of values in items array.
• variableName: string
  Title: Main Document Variable Name

  The variable name of the main document that the current transaction data belongs to.

{
    "type":"object",
    "description":"The transaction's main document data.",
    "title":"Main Document Data",
    "properties":{
        "variableName":{
            "type":"string",
            "description":"The variable name of the main document that the current transaction data belongs to.",
            "title":"Main Document Variable Name"
        },
        "attributes":{
            "$ref":"#/definitions/attributesDef"
        }
    }
}

Nested Schema : Process

Type: object

Title: Process

The transaction's process meta-data.

Show Source

• variableName: string
  Title: Process Variable Name

  The variable name of the process that the current transaction data belongs to.

{
    "type":"object",
    "description":"The transaction's process meta-data.",
    "title":"Process",
    "properties":{
        "variableName":{
            "type":"string",
            "description":"The variable name of the process that the current transaction data belongs to.",
            "title":"Process Variable Name"
        }
    }
}

Nested Schema : Attributes

Type: object

Title: Attributes

A set of key, value pairs with key being attribute's variableName and value being the value of the attribute.If its an msm, it can take list of values in items array.

Nested Schema : actions

Type: array

Array of actions names, whose state is requested in the state object response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of actions names, whose state is requested in the state object response.",
    "items":{
        "type":"string"
    }
}

Nested Schema : childDefs

Type: array

Show Source

• Array of: object Child query criteria.
  Title: Child query criteria.

  Captures the query criteria for the child resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/childQueryDef"
    }
}

Nested Schema : excludeFieldTypes

Type: array

Array of field names that you want to exclude in the response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names that you want to exclude in the response.",
    "items":{
        "type":"string"
    }
}

Nested Schema : expand

Type: array

Array of child resource names that you want to expand so that the contents return with the parent in the same request.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of child resource names that you want to expand so that the contents return with the parent in the same request.",
    "items":{
        "type":"string"
    }
}

Nested Schema : expandedDomainCriteria

Type: array

Map of dynamic menu field names, whose expanded domains are requested in the state object response, to a map of criteria, which are meant for filtering dynamic menu options. The criteria map should contain the node(s) information when dynamic menus on LIG are expanded. The criteria map also contains the search string. The search strings support contains, and are case-insensitive.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Map of dynamic menu field names, whose expanded domains are requested in the state object response, to a map of criteria, which are meant for filtering dynamic menu options. The criteria map should contain the node(s) information when dynamic menus on LIG are expanded. The criteria map also contains the search string. The search strings support contains, and are case-insensitive.",
    "items":{
        "type":"string"
    }
}

Nested Schema : expandedDomains

Type: array

Array of field names, whose expanded domains are requested in the state object response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names, whose expanded domains are requested in the state object response.",
    "items":{
        "type":"string"
    }
}

Nested Schema : fields

Type: array

Array of field names that you wanted returned in a request.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names that you wanted returned in a request.",
    "items":{
        "type":"string"
    }
}

Nested Schema : groups

Type: array

Array of group names, whose state is requested in the state object response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of group names, whose state is requested in the state object response.",
    "items":{
        "type":"string"
    }
}

Nested Schema : nodesExceptionList

Type: array

Array of document_number, recording the nodes that violate current expandNodes flag

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of document_number, recording the nodes that violate current expandNodes flag",
    "items":{
        "type":"string"
    }
}

Nested Schema : orderBy

Type: array

Array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.",
    "items":{
        "type":"string"
    }
}

Nested Schema : Child query criteria.

Type: object

Title: Child query criteria.

Captures the query criteria for the child resource.

Show Source

• name: string
  Rest alias name of the child resource this query belongs to.
• queryDef: object Query Definition
  Title: Query Definition

  Captures the query definition for the current resource request.
• recursive: boolean
  Boolean value that specifies whether this query is a recursive expand on the current child resource query.

{
    "type":"object",
    "properties":{
        "recursive":{
            "type":"boolean",
            "description":"Boolean value that specifies whether this query is a recursive expand on the current child resource query."
        },
        "name":{
            "type":"string",
            "description":"Rest alias name of the child resource this query belongs to."
        },
        "queryDef":{
            "$ref":"#/definitions/queryDef"
        }
    },
    "title":"Child query criteria.",
    "description":"Captures the query criteria for the child resource."
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Product Search Collection Response Definitions

Type: object

Title: Product Search Collection Response Definitions

Show Source

• result: object Product Collection Definitions
  Title: Product Collection Definitions

{
    "type":"object",
    "properties":{
        "result":{
            "$ref":"#/definitions/products-collection"
        }
    },
    "title":"Product Search Collection Response Definitions"
}

Nested Schema : Product Collection Definitions

Type: object

Title: Product Collection Definitions

Show Source

• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Returns true if more resources are available on the server than the subset returned in current page.
• items: array items
• limit: integer
  The actual paging size used by the server.
• offset: integer
  The offset used in the current page.
• totalResults: integer
  Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/products"
            }
        }
    },
    "title":"Product Collection Definitions"
}

Nested Schema : items

Type: array

Show Source

• Array of: object Product Instance Definitions
  Title: Product Instance Definitions

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/products"
    }
}

Nested 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