Create an opcode
POST/dms/{connection_id}/opcode
Creates a DmsOpcode. Provide the unified DmsOpcode fields in the request body; they are mapped to the provider's API. Returns the created DmsOpcode.
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
Payload
A service operation code (labor operation, menu or standard repair time)
idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
codestring
Operation code
descriptionstring
type enum
Valid values:
"LABOR"
"MENU"
"SUBLET"
"OTHER"
categorystring
Operation category or group
pay_type enum
Valid values:
"CUSTOMER"
"WARRANTY"
"INTERNAL"
"SERVICE_CONTRACT"
"OTHER"
Default pay type
flat_rate_hoursnumber
Billable (flat-rate) hours
estimated_hoursnumber
Expected duration, for scheduling
currencystring
ISO 4217 currency code
price_amountnumber
Fixed selling price
labor_rate_amountnumber
Default hourly labor rate
skill_codestring
Required technician skill or skill level
makestring
Vehicle make the operation applies to
oem_codestring
Manufacturer labor operation code
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) |
code | string | No | Operation code |
description | string | No | |
type | enum | No | Values: LABOR, MENU, SUBLET, OTHER |
category | string | No | Operation category or group |
pay_type | enum | No | Default pay type Values: CUSTOMER, WARRANTY, INTERNAL, SERVICE_CONTRACT, OTHER |
flat_rate_hours | number | No | Billable (flat-rate) hours |
estimated_hours | number | No | Expected duration, for scheduling |
currency | string | No | ISO 4217 currency code |
price_amount | number | No | Fixed selling price |
labor_rate_amount | number | No | Default hourly labor rate |
skill_code | string | No | Required technician skill or skill level |
make | string | No | Vehicle make the operation applies to |
oem_code | string | No | Manufacturer labor operation code |
is_active | boolean | No | |
parts | DmsPartline[] | No | Parts included in the operation |
parts[].id | string | No | Line identifier |
parts[].part_id | string | No | The DmsPart ID |
parts[].part_number | string | No | Part number as sold |
parts[].manufacturer_code | string | No | Make, brand or line code the part number belongs to |
parts[].description | string | No | |
parts[].pay_type | enum | No | Who pays for this line Values: CUSTOMER, WARRANTY, INTERNAL, SERVICE_CONTRACT, OTHER |
parts[].quantity | number | No | Quantity sold or issued |
parts[].quantity_ordered | number | No | Quantity requested by the customer |
parts[].unit_price_amount | number | No | Unit selling price |
parts[].list_price_amount | number | No | Unit list or retail price |
parts[].unit_cost_amount | number | No | Unit dealer cost |
parts[].total_amount | number | No | Extended selling amount |
parts[].total_cost_amount | number | No | Extended dealer cost |
parts[].tax_amount | number | 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: 'POST',
url: 'https://api.unified.to/dms/5de520f96e439b002043d8dc/opcode',
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?