Create a partsale
POST/dms/{connection_id}/partsale
Creates a DmsPartsale. Provide the unified DmsPartsale fields in the request body; they are mapped to the provider's API. Returns the created DmsPartsale.
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 parts counter sale, quote or return
idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
numberstring
Dealer-visible invoice, order or quote number
type enum
Valid values:
"SALE"
"QUOTE"
"RETURN"
"OTHER"
contact_idstring
Sold-to customer, as a CRM Contact
salesperson_user_idstring
Counter person, as an HR Employee (reference to HrisEmployee)
vehicle_idstring
The DmsVehicle the parts were sold for
pay_type enum
Valid values:
"CUSTOMER"
"WARRANTY"
"INTERNAL"
"SERVICE_CONTRACT"
"OTHER"
purchase_order_numberstring
Customer purchase order number
closed_atdate-time
When the sale was closed, cashiered or posted (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
shipped_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
currencystring
ISO 4217 currency code
subtotal_amountnumber
Total before tax
discount_amountnumber
freight_amountnumber
Freight, shipping or handling charge
tax_amountnumber
total_amountnumber
cost_amountnumber
Total dealer cost
notesstring
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) |
number | string | No | Dealer-visible invoice, order or quote number |
type | enum | No | Values: SALE, QUOTE, RETURN, OTHER |
status | enum | No | Values: DRAFT, OPEN, INVOICED, SHIPPED, CLOSED, VOIDED, OTHER |
contact_id | string | No | Sold-to customer, as a CRM Contact |
salesperson_user_id | string | No | Counter person, as an HR Employee (reference to HrisEmployee) |
vehicle_id | string | No | The DmsVehicle the parts were sold for |
pay_type | enum | No | Values: CUSTOMER, WARRANTY, INTERNAL, SERVICE_CONTRACT, OTHER |
purchase_order_number | string | No | Customer purchase order number |
closed_at | string (date-time) | No | When the sale was closed, cashiered or posted (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
shipped_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
currency | string | No | ISO 4217 currency code |
subtotal_amount | number | No | Total before tax |
discount_amount | number | No | |
freight_amount | number | No | Freight, shipping or handling charge |
tax_amount | number | No | |
total_amount | number | No | |
cost_amount | number | No | Total dealer cost |
notes | string | No | |
shipping_address | object | No | |
shipping_address.address1 | string | No | first line of the street address |
shipping_address.address2 | string | No | second line of the street address |
shipping_address.city | string | No | city or locality |
shipping_address.region | string | No | state, province or regional area |
shipping_address.region_code | string | No | state, province or regional area code |
shipping_address.postal_code | string | No | postal or ZIP code |
shipping_address.country | string | No | country name |
shipping_address.country_code | string | No | ISO 3166-1 alpha-2 country code |
lines | DmsPartline[] | No | |
lines[].id | string | No | Line identifier |
lines[].part_id | string | No | The DmsPart ID |
lines[].part_number | string | No | Part number as sold |
lines[].manufacturer_code | string | No | Make, brand or line code the part number belongs to |
lines[].description | string | No | |
lines[].pay_type | enum | No | Who pays for this line Values: CUSTOMER, WARRANTY, INTERNAL, SERVICE_CONTRACT, OTHER |
lines[].quantity | number | No | Quantity sold or issued |
lines[].quantity_ordered | number | No | Quantity requested by the customer |
lines[].unit_price_amount | number | No | Unit selling price |
lines[].list_price_amount | number | No | Unit list or retail price |
lines[].unit_cost_amount | number | No | Unit dealer cost |
lines[].total_amount | number | No | Extended selling amount |
lines[].total_cost_amount | number | No | Extended dealer cost |
lines[].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/partsale',
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?