Assign a substitute part
PATCH /api/erp/v1/part/obsolete/{obsolete} sets a substitute part for the part identified in the obsolete field. You can also set the substituted part’s status to Obsolete by setting the markOriginalAsObsolete to True.
Request schema
| Method |
URL |
| PATCH |
/api/erp/v1/part/obsolete/{obsolete} |
*indicates required fields
| Field |
Value type |
Description of values |
*Authorization |
String |
Enter: Bearer access token. |
| *obsolete |
Integer |
Item number for obsolete part. To get this number, open the BOM section of the project in the Upchain web app and locate the obsolete item in the BOM table. |
| *markOriginalAsObsolete |
Boolean |
Set field to True or False:
True: Original item’s status is set to Obsolete.False: Original item’s status remains unchanged.
|
*Upc-Selected-Company |
Integer |
Company’s ID. Use the value returned in the id field received in response to the following request: GET /api/auth/v1/companies. |
X-User-Id |
Text |
Enter the email address of the user being impersonated. This value is required if you are using a two-legged token. If you are using a three-legged token, then this field is not required. |
Request body
| Field |
Value type |
Description of values |
substituteErpPartId |
String |
Item number for substitute part as tracked in your ERP system. To get this number: - In the Upchain web app, open the BOM section of the project.
- Select the item in the BOM table to open its details pane.
The value is found in the Legacy Item Number field. |
Sample request
{
"substituteErpPartId": "PRT-12345"
}
Response schema
Response body
| Field |
Value type |
Description of values |
result |
Integer |
Always 1 for a 200-http response when the item’s substitute item is successfully updated. |
Sample response
{
"result": 1
}
