Update a part
PUT/dms/{connection_id}/part/{id}
Updates the DmsPart identified by id. Provide the unified DmsPart fields to change in the request body.
Parameters
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
idstring required
ID of the Part
Payload
A part in the dealer parts inventory
idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
part_numberstring
descriptionstring
manufacturer_codestring
Make, brand or line code the part number belongs to
source_codestring
Dealer price or source class code
supplier_codestring
Supplier the part is bought from
categorystring
Dealer part class or group
bin_locationsstring array
Bin or shelf locations
quantity_on_handnumber
quantity_availablenumber
Sellable quantity (on hand minus allocated)
quantity_on_ordernumber
Quantity on open supplier orders
min_stock_quantitynumber
Minimum stocking level
max_stock_quantitynumber
Maximum stocking level
pack_quantitynumber
Units per package
currencystring
ISO 4217 currency code
cost_amountnumber
Dealer unit cost
list_price_amountnumber
List or retail unit price
trade_price_amountnumber
Trade or wholesale unit price
superseded_by_part_numberstring
Part number that replaces this part
last_sold_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
last_received_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
is_activeboolean
Returns
| Response field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
part_number | string | No | |
description | string | No | |
manufacturer_code | string | No | Make, brand or line code the part number belongs to |
source_code | string | No | Dealer price or source class code |
supplier_code | string | No | Supplier the part is bought from |
category | string | No | Dealer part class or group |
bin_locations | string[] | No | Bin or shelf locations |
quantity_on_hand | number | No | |
quantity_available | number | No | Sellable quantity (on hand minus allocated) |
quantity_on_order | number | No | Quantity on open supplier orders |
min_stock_quantity | number | No | Minimum stocking level |
max_stock_quantity | number | No | Maximum stocking level |
pack_quantity | number | No | Units per package |
currency | string | No | ISO 4217 currency code |
cost_amount | number | No | Dealer unit cost |
list_price_amount | number | No | List or retail unit price |
trade_price_amount | number | No | Trade or wholesale unit price |
superseded_by_part_number | string | No | Part number that replaces this part |
last_sold_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
last_received_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
is_active | boolean | No | |
metadata | DmsMetadata[] | No | |
metadata[].id | string | No | The ID of the custom field definition (from the metadata/metadata endpoint). |
metadata[].slug | string | No | The integration's API name (key) of an existing custom field. |
metadata[].value | object | No | The field's value, typed by format. |
metadata[].namespace | string | No | |
metadata[].format | enum | No | The data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No |
Errors
Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).
{
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to unified.to API; max requests per minute: N"
}| Status | Error | Meaning |
|---|---|---|
400 | Bad Request | The request was malformed or failed validation. |
401 | Unauthorized | The connection is likely broken; re-authorize it. |
403 | Forbidden | The connection is missing permissions or scopes. |
404 | Not Found | The requested resource does not exist. |
429 | Too Many Requests | Rate limit exceeded (see the two sources below). |
500 | Internal Server Error | An unexpected error occurred. |
501 | Not Implemented | Not supported by this integration. |
Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.
429 Too Many Requests
A 429 has two possible sources:
- The integration's own rate limit, passed through.
- Unified's workspace limit: a rolling 60 seconds, set by plan, with the message
Too many requests to unified.to API; max requests per minute: N.
const options = {
method: 'PUT',
url: 'https://api.unified.to/dms/5de520f96e439b002043d8dc/part/5de520f96e439b002043d8d8',
headers: {
authorization: 'bearer .....'
},
data: undefined,
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know
Was this page helpful?