POST accounts/{accountId}/parts
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| accountId | integer |
Required |
Body Parameters
PartCreateDto| Name | Description | Type | Additional information |
|---|---|---|---|
| AccountId | integer |
None. |
|
| VendorId | integer |
None. |
|
| CategoryId | integer |
None. |
|
| Description | string |
None. |
|
| ShortDescription | string |
None. |
|
| PartNumber | string |
None. |
|
| UnitOfMeasureDescription | string |
None. |
|
| UnitOfMeasureCode | string |
None. |
|
| IsCustom | boolean |
None. |
|
| IsFreeform | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"AccountId": 1,
"VendorId": 2,
"CategoryId": 3,
"Description": "sample string 4",
"ShortDescription": "sample string 5",
"PartNumber": "sample string 6",
"UnitOfMeasureDescription": "sample string 7",
"UnitOfMeasureCode": "sample string 8",
"IsCustom": true,
"IsFreeform": true
}
Response Information
Resource Description
PartDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| VendorId | integer |
None. |
|
| Active | boolean |
None. |
|
| CategoryId | integer |
None. |
|
| Description | string |
None. |
|
| ShortDescription | string |
None. |
|
| PartNumber | string |
None. |
|
| UnitOfMeasureDescription | string |
None. |
|
| Vendor | VendorDto |
None. |
|
| Category | CategoryDto |
None. |
|
| LineItemOrderTemplateType | LineItemOrderTemplateType |
None. |
|
| LineItemDefaultStages | Collection of CreativeLineItemDefaultStageSearchResultDto |
None. |
|
| PartPartPropertyExtensions | Collection of PartPartPropertyExtensionDto |
None. |
|
| DesignEligible | boolean |
None. |
|
| IsDesignOnly | boolean |
None. |
|
| IsCustom | boolean |
None. |
|
| IsFreeform | boolean |
None. |
|
| IsBom | boolean |
None. |
|
| IsSelectable | boolean |
None. |
|
| IsAccessorialChargePart | boolean |
None. |
|
| ItemNumber | string |
None. |
|
| AssignedHeight | integer |
None. |
|
| AssignedWidth | integer |
None. |
|
| IsLandscape | boolean |
None. |
|
| UOM | string |
None. |
|
| DefaultWidthUOMCode | string |
None. |
|
| DefaultLengthUOMCode | string |
None. |
|
| DefaultWidth | decimal number |
None. |
|
| DefaultLength | decimal number |
None. |
|
| IsDimensionRequired | boolean |
None. |
|
| GroupSubGroup | string |
None. |
|
| FullPartNumber | string |
None. |
|
| BomSelectable | BomSelectablePartDto |
None. |
|
| ColorDescription | string |
None. |
|
| CreativePartTypeId | integer |
None. |
|
| OutputTypeId | OutputType |
None. |
|
| LineItemId | integer |
None. |
|
| GetIsDimensionAreaRequired | boolean |
None. |
|
| IsOutOfStock | boolean |
None. |
|
| IsNotAvailableAfterDeadline | boolean |
None. |
|
| IsStandardOffering | boolean |
None. |
|
| IsStandardBOM | boolean |
None. |
Response Information
Response body formats
application/json, text/json
Sample:
{
"Id": 1,
"VendorId": 2,
"Active": true,
"CategoryId": 1,
"Description": "sample string 4",
"ShortDescription": "sample string 5",
"PartNumber": "sample string 6",
"UnitOfMeasureDescription": "sample string 7",
"Vendor": {
"Id": 1,
"Name": "sample string 2",
"City": "sample string 3",
"Venue": "sample string 4",
"IsOnPriceList": true,
"IsFreeman": true,
"PriceLists": [
{
"Id": 1,
"Name": "sample string 2",
"FileName": "sample string 3",
"VendorId": 4,
"ShowId": 1,
"AccountId": 1,
"FileId": "sample string 5",
"CreatedDate": "2025-12-14T22:17:52.8332157+00:00",
"ModifiedDate": "2025-12-14T22:17:52.8332157+00:00",
"Errors": [
"sample string 1",
"sample string 2"
],
"ImportStatusId": 0,
"ImportStatus": 0,
"RefreshStatusId": 0,
"RefreshStatus": 0,
"IsBranchTemplate": true,
"AutoRefreshStatusId": 0,
"AutoRefreshStatus": 0
},
{
"Id": 1,
"Name": "sample string 2",
"FileName": "sample string 3",
"VendorId": 4,
"ShowId": 1,
"AccountId": 1,
"FileId": "sample string 5",
"CreatedDate": "2025-12-14T22:17:52.8332157+00:00",
"ModifiedDate": "2025-12-14T22:17:52.8332157+00:00",
"Errors": [
"sample string 1",
"sample string 2"
],
"ImportStatusId": 0,
"ImportStatus": 0,
"RefreshStatusId": 0,
"RefreshStatus": 0,
"IsBranchTemplate": true,
"AutoRefreshStatusId": 0,
"AutoRefreshStatus": 0
}
]
},
"Category": {
"Id": 1,
"Name": "sample string 2",
"IsParent": true,
"ChildrenCategories": [],
"ParentCategoryId": 1
},
"LineItemOrderTemplateType": 0,
"LineItemDefaultStages": [
{
"StageType": {
"Activity": 1,
"ActivityId": 1,
"StageTypeId": 2,
"StageTypeName": "sample string 3",
"NeedsDescription": true,
"IsDefault": true,
"NeedsSkipApprovalProcess": true,
"SortOrder": 7
},
"SequenceNumber": 1,
"LineItemStageStatusId": 1,
"BranchId": 2,
"CreativeLineItemId": 3,
"DueDate": "2025-12-14T22:17:52.8332157+00:00",
"StartDate": "2025-12-14T22:17:52.8332157+00:00",
"EndDate": "2025-12-14T22:17:52.8332157+00:00",
"CanEditStageDueDates": true,
"CanEditLineItemStages": true,
"CanDeleteLineItemStages": true,
"CanUnassignResourceOnStage": true,
"IsOnHold": true,
"CanPutOnHold": true,
"CanRestartFromOnHold": true
},
{
"StageType": {
"Activity": 1,
"ActivityId": 1,
"StageTypeId": 2,
"StageTypeName": "sample string 3",
"NeedsDescription": true,
"IsDefault": true,
"NeedsSkipApprovalProcess": true,
"SortOrder": 7
},
"SequenceNumber": 1,
"LineItemStageStatusId": 1,
"BranchId": 2,
"CreativeLineItemId": 3,
"DueDate": "2025-12-14T22:17:52.8332157+00:00",
"StartDate": "2025-12-14T22:17:52.8332157+00:00",
"EndDate": "2025-12-14T22:17:52.8332157+00:00",
"CanEditStageDueDates": true,
"CanEditLineItemStages": true,
"CanDeleteLineItemStages": true,
"CanUnassignResourceOnStage": true,
"IsOnHold": true,
"CanPutOnHold": true,
"CanRestartFromOnHold": true
}
],
"PartPartPropertyExtensions": [
{
"Id": 1,
"PartId": 2,
"PartPropertyExtensionId": 3
},
{
"Id": 1,
"PartId": 2,
"PartPropertyExtensionId": 3
}
],
"DesignEligible": true,
"IsDesignOnly": true,
"IsCustom": true,
"IsFreeform": true,
"IsBom": true,
"IsSelectable": true,
"IsAccessorialChargePart": true,
"ItemNumber": "sample string 14",
"AssignedHeight": 1,
"AssignedWidth": 1,
"IsLandscape": true,
"UOM": "sample string 15",
"DefaultWidthUOMCode": "sample string 16",
"DefaultLengthUOMCode": "sample string 17",
"DefaultWidth": 1.0,
"DefaultLength": 1.0,
"IsDimensionRequired": true,
"GroupSubGroup": "sample string 19",
"FullPartNumber": "sample string 20",
"BomSelectable": {
"PartId": 1,
"Description": "sample string 2",
"ColorDescription": "sample string 3",
"IsOnCurrentPriceList": true,
"IsParentPart": true,
"IsOutOfStock": true,
"IsNotAvailableAfterDeadline": true,
"IsStandardOffering": true,
"IsBom": true,
"BomParts": [],
"IsSelectable": true,
"SelectableOptions": []
},
"ColorDescription": "sample string 21",
"CreativePartTypeId": 1,
"OutputTypeId": 1,
"LineItemId": 22,
"GetIsDimensionAreaRequired": false,
"IsOutOfStock": true,
"IsNotAvailableAfterDeadline": true,
"IsStandardOffering": true,
"IsStandardBOM": true
}