Inventory
Update a part
Update an existing part
PATCH
/
parts
/
{id}
Update a part
curl --request PATCH \
--url https://api.oncanary.com/v1/parts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"part_number": "<string>",
"manufacturer": "<string>",
"minimum_stock": 123,
"extraFields": {},
"image_url": "<string>",
"image_blur": "<string>",
"part_type_id": "<string>"
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
part_number: '<string>',
manufacturer: '<string>',
minimum_stock: 123,
extraFields: {},
image_url: '<string>',
image_blur: '<string>',
part_type_id: '<string>'
})
};
fetch('https://api.oncanary.com/v1/parts/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.oncanary.com/v1/parts/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"part_number": "<string>",
"manufacturer": "<string>",
"minimum_stock": 123,
"extraFields": {},
"image_url": "<string>",
"image_blur": "<string>",
"part_type_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"part_number": "<string>",
"manufacturer": "<string>",
"minimum_stock": 123,
"part_type_id": "<string>",
"image_url": "<string>",
"extraFields": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"api_version": "<string>"
}
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}Authorizations
Organization API key with an sk_live_ or sk_test_ prefix
Path Parameters
Resource ID
Body
application/json
Maximum string length:
255Maximum string length:
1000Maximum string length:
255Maximum string length:
255Label-keyed custom-field values. Omitted labels remain unchanged on update.
Show child attributes
Show child attributes
Maximum string length:
2000⌘I
Update a part
curl --request PATCH \
--url https://api.oncanary.com/v1/parts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"part_number": "<string>",
"manufacturer": "<string>",
"minimum_stock": 123,
"extraFields": {},
"image_url": "<string>",
"image_blur": "<string>",
"part_type_id": "<string>"
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
part_number: '<string>',
manufacturer: '<string>',
minimum_stock: 123,
extraFields: {},
image_url: '<string>',
image_blur: '<string>',
part_type_id: '<string>'
})
};
fetch('https://api.oncanary.com/v1/parts/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.oncanary.com/v1/parts/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"part_number": "<string>",
"manufacturer": "<string>",
"minimum_stock": 123,
"extraFields": {},
"image_url": "<string>",
"image_blur": "<string>",
"part_type_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"part_number": "<string>",
"manufacturer": "<string>",
"minimum_stock": 123,
"part_type_id": "<string>",
"image_url": "<string>",
"extraFields": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"api_version": "<string>"
}
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}