POST accounts/{accountId}/partSearch
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| accountId | integer |
Required |
Body Parameters
PartMasterSearchDto| Name | Description | Type | Additional information |
|---|---|---|---|
| GroupId | integer |
None. |
|
| GroupNumber | integer |
None. |
|
| SubGroupNumber | integer |
None. |
|
| SubGroupId | integer |
None. |
|
| PartId | integer |
None. |
|
| PartNumber | string |
None. |
|
| SearchText | string |
None. |
|
| ExcludePartsOnPriceMaster | boolean |
None. |
|
| CategoryId | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"GroupId": 1,
"GroupNumber": 1,
"SubGroupNumber": 1,
"SubGroupId": 1,
"PartId": 1,
"PartNumber": "sample string 1",
"SearchText": "sample string 2",
"ExcludePartsOnPriceMaster": true,
"CategoryId": 1
}
Response Information
Resource Description
PartSearchHeaderDto| Name | Description | Type | Additional information |
|---|---|---|---|
| IsPartNotInPriceMaster | boolean |
None. |
|
| NoRecordsFound | boolean |
None. |
|
| PartHeaderDtos | Collection of PartHeaderDto |
None. |
Response Information
Response body formats
application/json, text/json
Sample:
{
"IsPartNotInPriceMaster": true,
"NoRecordsFound": true,
"PartHeaderDtos": [
{
"PartPriceListId": 1,
"PartId": 2,
"DesignEligible": true,
"IsDesignOnly": true,
"VendorId": 5,
"VendorName": "sample string 6",
"CategoryId": 1,
"CategoryName": "sample string 7",
"CategoryDisplayName": "sample string 8",
"Description": "sample string 9",
"ShortDescription": "sample string 10",
"PartNumber": "sample string 11",
"GroupId": 1,
"GroupNumber": 1.0,
"GroupDescription": "sample string 12",
"SubGroupId": 1,
"SubGroupNumber": 1.0,
"MaterialSubTypeNumber": 13.0,
"ColorDescription": "sample string 14",
"SubGroupDescription": "sample string 15",
"IsSelectable": true,
"IsAccessorialChargePart": true,
"LineItemOrderTemplateType": 0,
"CreativeLineItemDefaultStages": [
{
"StageType": {
"Activity": 1,
"StageTypeId": 1,
"StageTypeName": "sample string 2",
"NeedsDescription": true,
"IsDefault": true,
"NeedsSkipApprovalProcess": true,
"SortOrder": 6
},
"SequenceNumber": 1,
"LineItemStageStatusId": 1,
"BranchId": 2,
"CreativeLineItemId": 3,
"DueDate": "2025-05-06T01:56:54.2901392+01:00",
"StartDate": "2025-05-06T01:56:54.2901392+01:00",
"EndDate": "2025-05-06T01:56:54.2901392+01:00",
"CanEditStageDueDates": true,
"CanEditLineItemStages": true,
"CanDeleteLineItemStages": true,
"CanUnassignResourceOnStage": true,
"IsOnHold": true,
"CanPutOnHold": true,
"CanRestartFromOnHold": true
},
{
"StageType": {
"Activity": 1,
"StageTypeId": 1,
"StageTypeName": "sample string 2",
"NeedsDescription": true,
"IsDefault": true,
"NeedsSkipApprovalProcess": true,
"SortOrder": 6
},
"SequenceNumber": 1,
"LineItemStageStatusId": 1,
"BranchId": 2,
"CreativeLineItemId": 3,
"DueDate": "2025-05-06T01:56:54.2901392+01:00",
"StartDate": "2025-05-06T01:56:54.2901392+01:00",
"EndDate": "2025-05-06T01:56:54.2901392+01:00",
"CanEditStageDueDates": true,
"CanEditLineItemStages": true,
"CanDeleteLineItemStages": true,
"CanUnassignResourceOnStage": true,
"IsOnHold": true,
"CanPutOnHold": true,
"CanRestartFromOnHold": true
}
],
"AssignedHeight": 1,
"AssignedWidth": 1,
"IsLandscape": true,
"FOLIndicator": true,
"FOLLength": "sample string 17",
"FOLWidth": "sample string 18",
"FOLHeight": "sample string 19",
"FOLWeight": "sample string 20",
"FOLLengthUOMCode": "sample string 21",
"FOLWidthUOMCode": "sample string 22",
"FOLHeightUOMCode": "sample string 23",
"FOLWeightUOMCode": "sample string 24",
"FOLLengthUOMDesc": "sample string 25",
"FOLWidthUOMDesc": "sample string 26",
"FOLHeightUOMDesc": "sample string 27",
"FOLWeightUOMDesc": "sample string 28",
"UnitOfMeasureDescription": "sample string 29",
"UnitOfMeasureCode": "sample string 30",
"IsCustom": true,
"FullPartNumber": "sample string 32",
"AlternateDescritpion": "sample string 33",
"GroupSubGroup": "sample string 34",
"UOM": "sample string 30",
"PriceTiers": [
{
"Id": 1,
"PartPriceListId": 2,
"EffectiveDate": "2025-05-06T01:56:54.2901392+01:00",
"Price": 4.0,
"UserDisplayName": "sample string 5",
"ModifiedDate": "2025-05-06T01:56:54.2901392+01:00",
"PartPriceList": {
"Id": 1,
"PriceListId": 2,
"PartId": 3,
"Discount": 1.0,
"IsTaxable": true,
"IsOrderable": true,
"MinimumQuantity": 1.0,
"isOnCurrentPriceList": true,
"IsOutOfStock": true,
"IsNotAvailableAfterDeadline": true,
"IsStandardOffering": true,
"IsSupervisionFeeEligible": true,
"IsShowSpecificBOM": true
},
"PriceMasterTypeId": 1
},
{
"Id": 1,
"PartPriceListId": 2,
"EffectiveDate": "2025-05-06T01:56:54.2901392+01:00",
"Price": 4.0,
"UserDisplayName": "sample string 5",
"ModifiedDate": "2025-05-06T01:56:54.2901392+01:00",
"PartPriceList": {
"Id": 1,
"PriceListId": 2,
"PartId": 3,
"Discount": 1.0,
"IsTaxable": true,
"IsOrderable": true,
"MinimumQuantity": 1.0,
"isOnCurrentPriceList": true,
"IsOutOfStock": true,
"IsNotAvailableAfterDeadline": true,
"IsStandardOffering": true,
"IsSupervisionFeeEligible": true,
"IsShowSpecificBOM": true
},
"PriceMasterTypeId": 1
}
],
"IsOutOfStock": true,
"IsTaxable": true,
"Discount": 1.0,
"ItemDisplayNumber": "sample string 37",
"ItemDisplayDescription": "sample string 38",
"Id": 2,
"OutputTypeId": 1,
"PartBackingMaterials": [
{
"PartId": 1,
"PartBackingMaterialId": 2,
"PartBackingMaterialType": "sample string 3"
},
{
"PartId": 1,
"PartBackingMaterialId": 2,
"PartBackingMaterialType": "sample string 3"
}
],
"GetIsDimensionAreaRequired": true,
"IsStandardBOM": true
},
{
"PartPriceListId": 1,
"PartId": 2,
"DesignEligible": true,
"IsDesignOnly": true,
"VendorId": 5,
"VendorName": "sample string 6",
"CategoryId": 1,
"CategoryName": "sample string 7",
"CategoryDisplayName": "sample string 8",
"Description": "sample string 9",
"ShortDescription": "sample string 10",
"PartNumber": "sample string 11",
"GroupId": 1,
"GroupNumber": 1.0,
"GroupDescription": "sample string 12",
"SubGroupId": 1,
"SubGroupNumber": 1.0,
"MaterialSubTypeNumber": 13.0,
"ColorDescription": "sample string 14",
"SubGroupDescription": "sample string 15",
"IsSelectable": true,
"IsAccessorialChargePart": true,
"LineItemOrderTemplateType": 0,
"CreativeLineItemDefaultStages": [
{
"StageType": {
"Activity": 1,
"StageTypeId": 1,
"StageTypeName": "sample string 2",
"NeedsDescription": true,
"IsDefault": true,
"NeedsSkipApprovalProcess": true,
"SortOrder": 6
},
"SequenceNumber": 1,
"LineItemStageStatusId": 1,
"BranchId": 2,
"CreativeLineItemId": 3,
"DueDate": "2025-05-06T01:56:54.2901392+01:00",
"StartDate": "2025-05-06T01:56:54.2901392+01:00",
"EndDate": "2025-05-06T01:56:54.2901392+01:00",
"CanEditStageDueDates": true,
"CanEditLineItemStages": true,
"CanDeleteLineItemStages": true,
"CanUnassignResourceOnStage": true,
"IsOnHold": true,
"CanPutOnHold": true,
"CanRestartFromOnHold": true
},
{
"StageType": {
"Activity": 1,
"StageTypeId": 1,
"StageTypeName": "sample string 2",
"NeedsDescription": true,
"IsDefault": true,
"NeedsSkipApprovalProcess": true,
"SortOrder": 6
},
"SequenceNumber": 1,
"LineItemStageStatusId": 1,
"BranchId": 2,
"CreativeLineItemId": 3,
"DueDate": "2025-05-06T01:56:54.2901392+01:00",
"StartDate": "2025-05-06T01:56:54.2901392+01:00",
"EndDate": "2025-05-06T01:56:54.2901392+01:00",
"CanEditStageDueDates": true,
"CanEditLineItemStages": true,
"CanDeleteLineItemStages": true,
"CanUnassignResourceOnStage": true,
"IsOnHold": true,
"CanPutOnHold": true,
"CanRestartFromOnHold": true
}
],
"AssignedHeight": 1,
"AssignedWidth": 1,
"IsLandscape": true,
"FOLIndicator": true,
"FOLLength": "sample string 17",
"FOLWidth": "sample string 18",
"FOLHeight": "sample string 19",
"FOLWeight": "sample string 20",
"FOLLengthUOMCode": "sample string 21",
"FOLWidthUOMCode": "sample string 22",
"FOLHeightUOMCode": "sample string 23",
"FOLWeightUOMCode": "sample string 24",
"FOLLengthUOMDesc": "sample string 25",
"FOLWidthUOMDesc": "sample string 26",
"FOLHeightUOMDesc": "sample string 27",
"FOLWeightUOMDesc": "sample string 28",
"UnitOfMeasureDescription": "sample string 29",
"UnitOfMeasureCode": "sample string 30",
"IsCustom": true,
"FullPartNumber": "sample string 32",
"AlternateDescritpion": "sample string 33",
"GroupSubGroup": "sample string 34",
"UOM": "sample string 30",
"PriceTiers": [
{
"Id": 1,
"PartPriceListId": 2,
"EffectiveDate": "2025-05-06T01:56:54.2901392+01:00",
"Price": 4.0,
"UserDisplayName": "sample string 5",
"ModifiedDate": "2025-05-06T01:56:54.2901392+01:00",
"PartPriceList": {
"Id": 1,
"PriceListId": 2,
"PartId": 3,
"Discount": 1.0,
"IsTaxable": true,
"IsOrderable": true,
"MinimumQuantity": 1.0,
"isOnCurrentPriceList": true,
"IsOutOfStock": true,
"IsNotAvailableAfterDeadline": true,
"IsStandardOffering": true,
"IsSupervisionFeeEligible": true,
"IsShowSpecificBOM": true
},
"PriceMasterTypeId": 1
},
{
"Id": 1,
"PartPriceListId": 2,
"EffectiveDate": "2025-05-06T01:56:54.2901392+01:00",
"Price": 4.0,
"UserDisplayName": "sample string 5",
"ModifiedDate": "2025-05-06T01:56:54.2901392+01:00",
"PartPriceList": {
"Id": 1,
"PriceListId": 2,
"PartId": 3,
"Discount": 1.0,
"IsTaxable": true,
"IsOrderable": true,
"MinimumQuantity": 1.0,
"isOnCurrentPriceList": true,
"IsOutOfStock": true,
"IsNotAvailableAfterDeadline": true,
"IsStandardOffering": true,
"IsSupervisionFeeEligible": true,
"IsShowSpecificBOM": true
},
"PriceMasterTypeId": 1
}
],
"IsOutOfStock": true,
"IsTaxable": true,
"Discount": 1.0,
"ItemDisplayNumber": "sample string 37",
"ItemDisplayDescription": "sample string 38",
"Id": 2,
"OutputTypeId": 1,
"PartBackingMaterials": [
{
"PartId": 1,
"PartBackingMaterialId": 2,
"PartBackingMaterialType": "sample string 3"
},
{
"PartId": 1,
"PartBackingMaterialId": 2,
"PartBackingMaterialType": "sample string 3"
}
],
"GetIsDimensionAreaRequired": true,
"IsStandardBOM": true
}
]
}