Update an item's status - identify the item using the item number
PATCH /api/erp/v1/part/{itemNumber}
endpoint updates the part’s status in Upchain. The part is specified in the itemNumber
field. This is logged in the part’s history.
Request schema
Method |
URL |
PATCH |
/api/erp/v1/part/{itemNumber} |
Field |
Value type |
Description of values |
*Authorization |
String |
Enter: Bearer access token. |
*itemNumber |
Integer |
Item number recorded against an item. To get this number, open the BOM section of the project in the Upchain web app and locate the item in the BOM table. |
*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 |
partStatus |
String |
Item’s new status. |
Sample request
{
"partStatus": "Obsolete"
}
Response schema
Response body
Field |
Value type |
Description of values |
result |
Integer |
Always 1 for a 200-http response when the item’s status is successfully updated. |
Sample response
{
"result": 1
}