Search Parts

Finds the parts that match the search criteria. Specify at least one search criteria.

Resource Information

Scopeparts

Deprecated scope name:   search_parts

App TypeAgency
Authorization TypeAccess token
URI /v4/search/parts?offset={offset}&limit={limit}&fields={fields}&lang={lang}
HTTP MethodPOST
Automation Version(s)7.3.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
fieldsstringNo Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.7.3.2
langStringNo Indicates the language applied.7.3.2
limitlongNo Indicates the number of items that are returned in each page.7.3.2
offsetlongNo Indicates the offset start of each page by the number specified.7.3.2
brandbrand{}No The brand name of the asset.7.3.3
brand.textstringNo The localized display text.7.3.2
brand.valuestringNo The value for the specified parameter.7.3.2
budgetAccountbudgetAccount{}No The budget account name associated with the asset.7.3.3
budgetAccount.textstringNo The localized display text.7.3.2
budgetAccount.valuestringNo The value for the specified parameter.7.3.2
budgetNumberstringNo The budget account number associated with the asset.7.3.3
calculateTypecalculateType{}No Specifies the type used to calculate the average cost of the part: "Simple" : The average cost is equal to the sum of the unit cost of a current shipment and existing average cost, divided by two. This provides the average value of the existing average cost and the cost per unit of the current shipment. "Weighted" : This is the same as the Simple Average, but weighted by quantity. This means that the existing part quantity is multiplied by the existing average cost and then the quantity of the current shipment is multiplied by the unit cost of the shipment. Then the sum of these values is divided by the total part quantity.7.3.3
calculateType.textstringNo The localized display text.7.3.2
calculateType.valuestringNo The value for the specified parameter.7.3.2
commentsstringNo Comments or notes about the current context.7.3.3
descriptiondescription{}No The description of the record or item.7.3.3
description.textstringNo The localized display text.7.3.2
description.valuestringNo The value for the specified parameter.7.3.2
hardReservedoubleNo The quantity set aside as hard-reserved.7.3.3
idlongNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3
maximumQuantitydoubleNo The maximum quantity of asset parts.7.3.3
minimumQuantitydoubleNo The minimum quantity of asset parts.7.3.3
partNumberstringNo The number of the part.7.3.3
partStatuspartStatus{}No The status of the part.7.3.3
partStatus.textstringNo The localized display text.7.3.2
partStatus.valuestringNo The value for the specified parameter.7.3.2
reorderDuestringNo The status of reorder displays “Yes” if the total supply is greater than the minimum quantity. The reorder due displays “No” if the total supply is less than the minimum quantity.7.3.3
reorderQuantitydoubleNo The quantity to reorder.7.3.3
reservedQuantitydoubleNo The quantity reserved.7.3.3
statusstatus{}No The part inventory status.7.3.3
status.textstringNo The localized display text.7.3.2
status.valuestringNo The value for the specified parameter.7.3.2
taxablestringNoY | NIndicates whether or not the part is taxable.7.3.3
totalSupplydoubleNo The total quantity on hand for the part.7.3.3
trackCostByLocationstringNoY | NIndicates whether or not to track the cost of a part based on its stock location.7.3.3
typetype{}No Get Part Types The part type, such Fittings, Fleet, Materials.7.3.3
type.textstringNo The localized display text.7.3.2
type.valuestringNo The value for the specified parameter.7.3.2
unitCostdoubleNo The unit cost per part.7.3.3
unitOfMeasureunitOfMeasure{}No The unit of measurement for quantifying the part.7.3.3
unitOfMeasure.textstringNo The localized display text.7.3.2
unitOfMeasure.valuestringNo The value for the specified parameter.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.3
result.brandresult.brand{}The brand name of the asset.7.3.3
result.brand.textstringThe localized display text.7.3.2
result.brand.valuestringThe value for the specified parameter.7.3.2
result.budgetAccountresult.budgetAccount{}The budget account name associated with the asset.7.3.3
result.budgetAccount.textstringThe localized display text.7.3.2
result.budgetAccount.valuestringThe value for the specified parameter.7.3.2
result.budgetNumberstringThe budget account number associated with the asset.7.3.3
result.calculateTyperesult.calculateType{}Specifies the type used to calculate the average cost of the part: "Simple" : The average cost is equal to the sum of the unit cost of a current shipment and existing average cost, divided by two. This provides the average value of the existing average cost and the cost per unit of the current shipment. "Weighted" : This is the same as the Simple Average, but weighted by quantity. This means that the existing part quantity is multiplied by the existing average cost and then the quantity of the current shipment is multiplied by the unit cost of the shipment. Then the sum of these values is divided by the total part quantity.7.3.3
result.calculateType.textstringThe localized display text.7.3.2
result.calculateType.valuestringThe value for the specified parameter.7.3.2
result.commentsstringComments or notes about the current context.7.3.3
result.descriptionresult.description{}The description of the record or item.7.3.3
result.description.textstringThe localized display text.7.3.2
result.description.valuestringThe value for the specified parameter.7.3.2
result.hardReservedoubleThe quantity set aside as hard-reserved.7.3.3
result.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3
result.maximumQuantitydoubleThe maximum quantity of asset parts.7.3.3
result.minimumQuantitydoubleThe minimum quantity of asset parts.7.3.3
result.partNumberstringThe number of the part.7.3.3
result.partStatusresult.partStatus{}The status of the part.7.3.3
result.partStatus.textstringThe localized display text.7.3.2
result.partStatus.valuestringThe value for the specified parameter.7.3.2
result.reorderDuestringThe status of reorder displays “Yes” if the total supply is greater than the minimum quantity. The reorder due displays “No” if the total supply is less than the minimum quantity.7.3.3
result.reorderQuantitydoubleThe quantity to reorder.7.3.3
result.reservedQuantitydoubleThe quantity reserved.7.3.3
result.statusresult.status{}The part inventory status.7.3.3
result.status.textstringThe localized display text.7.3.2
result.status.valuestringThe value for the specified parameter.7.3.2
result.taxablestringIndicates whether or not the part is taxable.7.3.3
result.totalSupplydoubleThe total quantity on hand for the part.7.3.3
result.trackCostByLocationstringIndicates whether or not to track the cost of a part based on its stock location.7.3.3
result.typeresult.type{}The part type, such Fittings, Fleet, Materials.7.3.3
result.type.textstringThe localized display text.7.3.2
result.type.valuestringThe value for the specified parameter.7.3.2
result.unitCostdoubleThe unit cost per part.7.3.3
result.unitOfMeasureresult.unitOfMeasure{}The unit of measurement for quantifying the part.7.3.3
result.unitOfMeasure.textstringThe localized display text.7.3.2
result.unitOfMeasure.valuestringThe value for the specified parameter.7.3.2
statusintegerThe record status.7.3.3