Jump to

• Request
• Response
• Examples

Searches Parts List

post

/rest/v16/parts/actions/search

This operation is used to search parts based on Configuration attribute values. If account and user information is available in the authentication token, Eligibility Rules created on user and account attributes are applied.

Request

Supported Media Types

• application/json

Body ()

Root Schema : Part Search Collection Request Definitions

Type: object

Title: Part Search Collection Request Definitions

Show Source

• context: object Part Search Context
  Title: Part Search Context

  Context definition for part 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/partSearchContext"
        }
    },
    "title":"Part Search Collection Request Definitions"
}

Nested Schema : Part Search Context

Type: object

Title: Part Search Context

Context definition for part search.

Show Source

• commerce: object Commerce Data
  Title: Commerce Data

  Transaction data for part search.
• config: object Config Data
  Title: Config Data

  Config data for part 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 part 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":"MainDocument Data",
                    "properties":{
                        "variableName":{
                            "type":"string",
                            "description":"The variable name of the main document that the current transaction data belongs to.",
                            "title":"MainDocument Variable Name"
                        },
                        "attributes":{
                            "$ref":"#/definitions/attributesDef"
                        }
                    }
                }
            }
        },
        "config":{
            "type":"object",
            "description":"Config data for part search.",
            "title":"Config Data",
            "properties":{
                "currencyCode":{
                    "type":"string",
                    "description":"The currencyCode value in which the attribute is represented",
                    "title":"Currency Code"
                },
                "allProducts":{
                    "type":"object",
                    "description":"Holds attribute data that belong to all products",
                    "title":"All Products",
                    "properties":{
                        "attributes":{
                            "$ref":"#/definitions/attributesDef"
                        }
                    }
                },
                "segment":{
                    "$ref":"#/definitions/configDataDef"
                },
                "productLine":{
                    "$ref":"#/definitions/configDataDef"
                },
                "model":{
                    "$ref":"#/definitions/configDataDef"
                }
            }
        }
    },
    "title":"Part Search Context",
    "description":"Context definition for part 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
• 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.
• expandedDomains: array expandedDomains
  Array of field names, whose expanded domains are requested in the state object response.
• fields: array fields
  Array of field names that you wanted returned in a request.
• 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.

{
    "type":"object",
    "properties":{
        "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."
        },
        "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"
            }
        },
        "actions":{
            "type":"array",
            "description":"Array of actions 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"
            }
        }
    },
    "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 part 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 MainDocument Data
  Title: MainDocument Data

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

  The transaction's process meta-data.

{
    "type":"object",
    "description":"Transaction data for part 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":"MainDocument Data",
            "properties":{
                "variableName":{
                    "type":"string",
                    "description":"The variable name of the main document that the current transaction data belongs to.",
                    "title":"MainDocument Variable Name"
                },
                "attributes":{
                    "$ref":"#/definitions/attributesDef"
                }
            }
        }
    }
}

Nested Schema : Config Data

Type: object

Title: Config Data

Config data for part search.

Show Source

• allProducts: object All Products
  Title: All Products

  Holds attribute data that belong to all products
• currencyCode: string
  Title: Currency Code

  The currencyCode value in which the attribute is represented
• model: object ConfiguratorDataDefinition
  Title: ConfiguratorDataDefinition

  Holds configurator related data like variable name and attribute values
• productLine: object ConfiguratorDataDefinition
  Title: ConfiguratorDataDefinition

  Holds configurator related data like variable name and attribute values
• segment: object ConfiguratorDataDefinition
  Title: ConfiguratorDataDefinition

  Holds configurator related data like variable name and attribute values

{
    "type":"object",
    "description":"Config data for part search.",
    "title":"Config Data",
    "properties":{
        "currencyCode":{
            "type":"string",
            "description":"The currencyCode value in which the attribute is represented",
            "title":"Currency Code"
        },
        "allProducts":{
            "type":"object",
            "description":"Holds attribute data that belong to all products",
            "title":"All Products",
            "properties":{
                "attributes":{
                    "$ref":"#/definitions/attributesDef"
                }
            }
        },
        "segment":{
            "$ref":"#/definitions/configDataDef"
        },
        "productLine":{
            "$ref":"#/definitions/configDataDef"
        },
        "model":{
            "$ref":"#/definitions/configDataDef"
        }
    }
}

Nested Schema : MainDocument Data

Type: object

Title: MainDocument 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: MainDocument 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":"MainDocument Data",
    "properties":{
        "variableName":{
            "type":"string",
            "description":"The variable name of the main document that the current transaction data belongs to.",
            "title":"MainDocument 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 : All Products

Type: object

Title: All Products

Holds attribute data that belong to all products

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.

{
    "type":"object",
    "description":"Holds attribute data that belong to all products",
    "title":"All Products",
    "properties":{
        "attributes":{
            "$ref":"#/definitions/attributesDef"
        }
    }
}

Nested Schema : ConfiguratorDataDefinition

Type: object

Title: ConfiguratorDataDefinition

Holds configurator related data like variable name and attribute values

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
  The variableName of the configurator entity like segment,productLine,model

{
    "type":"object",
    "properties":{
        "variableName":{
            "type":"string",
            "description":"The variableName of the configurator entity like segment,productLine,model"
        },
        "attributes":{
            "$ref":"#/definitions/attributesDef"
        }
    },
    "title":"ConfiguratorDataDefinition",
    "description":"Holds configurator related data like variable name and attribute values"
}

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 : 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 : 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 : 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 : Part Search Collection Response Definitions

Type: object

Title: Part Search Collection Response Definitions

Show Source

• result: object Part Collection Definitions
  Title: Part Collection Definitions

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

Nested Schema : Part Collection Definitions

Type: object

Title: Part 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/parts"
            }
        }
    },
    "title":"Part Collection Definitions"
}

Nested Schema : items

Type: array

Show Source

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

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

Nested Schema : Part Instance Definitions

Type: object

Title: Part Instance Definitions

Show Source

• bomItemVariableName: string
  Title: Default Bom Item Variable Name

  Variable name of the root BOM item.
• configurableFlag: object Configurable Flag
  Title: Configurable Flag

  Part Configurable Flag
• dateAdded: string
  Title: Date Added

  System field indicating the date on which the Resource was created.
• dateModified: string
  Title: Date Modified

  System field indicating the date on which the Resource was last modified.
• defaultUOMCode: string
  Title: Default UOM Code

  Default Unit of Measure.
• description: string
  Title: Description

  Description of the part
• directBuy: object Direct Buy
  Title: Direct Buy

  Determines how the part must be purchased.
• eligibleForService: string
  Title: Eligible for Service

  Enable this option, when integrating with a service request application.
• eligibleToSell: string
  Title: Eligible to Sell

  Check this if the part should be visible to a sales person (If the part is sellable or not).
• enableSelfService: string
  Title: Enable Customer Self-Service

  When integrating with any customer self service application- enable this option to identify parts as self-service eligible.
• externalKey1: string
  Title: External Key 1

  References for parts coming in from external third party system.
• externalKey2: string
  Title: External Key 2

  References for parts coming in from external third party system.
• id: integer
  Title: Id

  Primary Key of the part resource.
• leadTime: integer
  Title: Lead Time

  Time taken in days for the part to be shipped.
• numberOfPricePeriods: integer
  Title: Number of Price Periods

  Default number of price periods for a part.
• partDisplayNumber: string
  Title: Part Display Number

  Part Number for display purpose.
• partNumber: string
  Title: Part Number

  Part Number used to identify a part.
• partNumberLower: string
  Title: Part Number Lower

  Used to store part number in lower case.
• pricePeriod: string
  Title: Price Period

  Default price period for the period.
• priceType: string
  Title: Price Type

  Default price type applicable to the part- e.g. One-Time, Recurring or Usage-based.
• salesProductType: string
  Title: Sales Product Type

  Categorize the product by selecting a product type.
• status: object Product Status
  Title: Product Status

  Status of the product
• units: string
  Title: Units

  Number of units for the part number

{
    "type":"object",
    "properties":{
        "bomItemVariableName":{
            "type":"string",
            "description":"Variable name of the root BOM item.",
            "title":"Default Bom Item Variable Name"
        },
        "configurableFlag":{
            "type":"object",
            "description":"Part Configurable Flag",
            "title":"Configurable Flag",
            "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"
                }
            }
        },
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "defaultUOMCode":{
            "type":"string",
            "description":"Default Unit of Measure.",
            "title":"Default UOM Code"
        },
        "description":{
            "type":"string",
            "description":"Description of the part",
            "title":"Description"
        },
        "directBuy":{
            "type":"object",
            "description":"Determines how the part must be purchased.",
            "title":"Direct Buy",
            "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"
                }
            }
        },
        "eligibleForService":{
            "type":"string",
            "description":"Enable this option, when integrating with a service request application.",
            "title":"Eligible for Service"
        },
        "eligibleToSell":{
            "type":"string",
            "description":"Check this if the part should be visible to a sales person (If the part is sellable or not).",
            "title":"Eligible to Sell"
        },
        "enableSelfService":{
            "type":"string",
            "description":"When integrating with any customer self service application- enable this option to identify parts as self-service eligible.",
            "title":"Enable Customer Self-Service"
        },
        "externalKey1":{
            "type":"string",
            "description":"References for parts coming in from external third party system.",
            "title":"External Key 1"
        },
        "externalKey2":{
            "type":"string",
            "description":"References for parts coming in from external third party system.",
            "title":"External Key 2"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the part resource.",
            "title":"Id"
        },
        "leadTime":{
            "type":"integer",
            "description":"Time taken in days for the part to be shipped.",
            "title":"Lead Time"
        },
        "numberOfPricePeriods":{
            "type":"integer",
            "description":"Default number of price periods for a part.",
            "title":"Number of Price Periods"
        },
        "partDisplayNumber":{
            "type":"string",
            "description":"Part Number for display purpose.",
            "title":"Part Display Number"
        },
        "partNumber":{
            "type":"string",
            "description":"Part Number used to identify a part.",
            "title":"Part Number"
        },
        "partNumberLower":{
            "type":"string",
            "description":"Used to store part number in lower case.",
            "title":"Part Number Lower"
        },
        "pricePeriod":{
            "type":"string",
            "description":"Default price period for the period.",
            "title":"Price Period"
        },
        "priceType":{
            "type":"string",
            "description":"Default price type applicable to the part- e.g. One-Time, Recurring or Usage-based.",
            "title":"Price Type"
        },
        "salesProductType":{
            "type":"string",
            "description":"Categorize the product by selecting a product type.",
            "title":"Sales Product Type"
        },
        "status":{
            "type":"object",
            "description":"Status of the product",
            "title":"Product 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"
                }
            }
        },
        "units":{
            "type":"string",
            "description":"Number of units for the part number",
            "title":"Units"
        }
    },
    "title":"Part Instance Definitions"
}

Nested Schema : Configurable Flag

Type: object

Title: Configurable Flag

Part Configurable Flag

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":"Part Configurable Flag",
    "title":"Configurable Flag",
    "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 : Direct Buy

Type: object

Title: Direct Buy

Determines how the part must be purchased.

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":"Determines how the part must be purchased.",
    "title":"Direct Buy",
    "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 : Product Status

Type: object

Title: Product Status

Status 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":"Status of the product",
    "title":"Product 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

Examples

The Search Parts REST API supports customizing the REST response by specifying an advanced query object (i.e. "q" criteria) as a request body parameter. This allows administrators to customize the query by specifying various combinations of criteria.

The following examples show how to search parts by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X POST - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/parts/actions/search

Search Parts Using Configuration Context

This operation is used to search parts based on Configuration attribute values. If account and user information is available in the authentication token, Eligibility Rules created on user and account attributes are applied.

Request Body Sample

{
   "criteria": {
      "totalResults": true,
      "limit": 15,
      "offset": 0,
      "fields": ["partNumber", "_part_custom_field8", "_part_custom_field9", "_part_custom_field11", "_part_custom_field17", "directBuy", "units", "leadTime", "partDisplayNumber"],
      "q": "{\"partNumber\":{\"$like\": \"EligibilityForPartRESTAPICONFIGPart%\"}}"
   },
   "context": {
      "pricebookVarName": "pricebook1",
      "config": {
         "allProducts": {
            "attributes": {
               "conditionsAllPF": "true"
            }
         },
         "segment": {
            "variableName": "testbed",
            "attributes": {
               "aVPMSMCheckboxesOther": {
                  "items": ["Value 1"]
               }
            }
         },
         "productLine": {
            "variableName": "recommendedItems",
            "attributes": {
               "advancedCondition1": "true"
            }
         },
         "model": {
            "variableName": "performance",
            "attributes": {
               "numberOfLineItems": "50"
            }
         }
      }
   }
}

Search Parts Using Commerce Context

When an Eligibility Rule is based on a Commerce attribute and a Transaction is created with values that satisfy the Eligibility Rule, this operation is used to search for parts using Transaction data.

Request Body Sample

{
   "criteria": {
      "totalResults": true,
      "limit": 15,
      "offset": 0,
      "fields": ["partNumber", "_part_custom_field8", "_part_custom_field9", "_part_custom_field11", "_part_custom_field17", "directBuy", "units", "leadTime", "partDisplayNumber"],
      "q": "{\"partNumber\":{\"$like\": \"Basic Pricing 01\"}}"
   },
   "context": {
      "pricebookVarName": "pricebook1",
      "commerce": {
         "id": "20587705"
      }
   }
}

Perform a Quick Key Search in Commerce

In a CPQ Transaction, Quick Key line items are used to add parts to a quote without navigating away from the Transaction page and to auto - suggest a part to aid in part selection.The Search Part REST API allows implementers to build similar functionality where the Quick Key part selector auto - populates with part numbers when users enter characters into an item field in the Line Item Grid.

Request Body Sample

{
   "context": {
      "pricebookVarName": "pricebook1",
      "commerce": {
         "id": "20516360",
         "cacheInstanceId": "3KR11zuA1UZzhlH2ohStrgwgRrlrYa9YbrSIY2OofoRPBbluv12MCYfm40Ag33nGP"
      }
   },
   "criteria": {
      "q": "{\"partNumber\":{$like: \"part2690%\", $options:\"I\"}}",
      "fields": ["partDisplayNumber", "partNumber"],
      "totalResults": true,
      "limit": 10,
      "offset": 0
   }
}

Notes:

• If cacheInstanceId is present, the id and process data are ignored.
• If cacheInstanceId is not present and id is present, the id is used.
• If cacheInstanceId and id are not available, Commerce attribute values are passed.

Search List of Part Numbers

Used to filter a given list of parts. The list of parts is provided in the "q" parameter(concatenated with 'OR') of the criteria object.

Request Body Sample

{
   "context": {
      "pricebookVarName": "pricebook1",
      "commerce": {
         "id": "20104203"
      }
   },
   "criteria": {
      "q": "{ $or: [ { \"partNumber\": { $eq: \"part2690\" }}, { \"partNumber\": { $eq: \"part2691\" }} ] }"
   }
}

Perform an Advanced Part Search

This operation is used to search for parts using a single or combination of multiple part fields with Eligibility Rules applied. The part search criteria supports operators based on field type.

Request Body Sample

Search parts based on a part custom field, such as an MSM field.As shown in the below example, any MSM field can be searched using the value attribute.

{
   "criteria": {
      "totalResults": true,
      "limit": 5,
      "offset": 0,
      "fields": ["_part_customfield16", "partNumber"],
      "q": "{$and:[{partNumber:\"EligibilityForPartRESTAPIPart3\"},{\"_part_customfield16.value\":{$ne:[\"Value 1\"]}}]}"
   },
   "context": {
      "pricebookVarname": "pricebook1"
   }
}

Back to Top