Update a partsale

Updated:

PUT/dms/{connection_id}/partsale/{id}

Updates the DmsPartsale identified by id. Provide the unified DmsPartsale 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 Partsale

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"
status enum
Valid values:
"DRAFT"
"OPEN"
"INVOICED"
"SHIPPED"
"CLOSED"
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
shipping_addressobject
lines array
metadata array

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
numberstringNoDealer-visible invoice, order or quote number
typeenumNoValues: SALE, QUOTE, RETURN, OTHER
statusenumNoValues: DRAFT, OPEN, INVOICED, SHIPPED, CLOSED, VOIDED, OTHER
contact_idstringNoSold-to customer, as a CRM Contact
salesperson_user_idstringNoCounter person, as an HR Employee (reference to HrisEmployee)
vehicle_idstringNoThe DmsVehicle the parts were sold for
pay_typeenumNoValues: CUSTOMER, WARRANTY, INTERNAL, SERVICE_CONTRACT, OTHER
purchase_order_numberstringNoCustomer purchase order number
closed_atstring (date-time)NoWhen the sale was closed, cashiered or posted (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
shipped_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
currencystringNoISO 4217 currency code
subtotal_amountnumberNoTotal before tax
discount_amountnumberNo
freight_amountnumberNoFreight, shipping or handling charge
tax_amountnumberNo
total_amountnumberNo
cost_amountnumberNoTotal dealer cost
notesstringNo
shipping_addressobjectNo
shipping_address.address1stringNofirst line of the street address
shipping_address.address2stringNosecond line of the street address
shipping_address.citystringNocity or locality
shipping_address.regionstringNostate, province or regional area
shipping_address.region_codestringNostate, province or regional area code
shipping_address.postal_codestringNopostal or ZIP code
shipping_address.countrystringNocountry name
shipping_address.country_codestringNoISO 3166-1 alpha-2 country code
linesDmsPartline[]No
lines[].idstringNoLine identifier
lines[].part_idstringNoThe DmsPart ID
lines[].part_numberstringNoPart number as sold
lines[].manufacturer_codestringNoMake, brand or line code the part number belongs to
lines[].descriptionstringNo
lines[].pay_typeenumNoWho pays for this line Values: CUSTOMER, WARRANTY, INTERNAL, SERVICE_CONTRACT, OTHER
lines[].quantitynumberNoQuantity sold or issued
lines[].quantity_orderednumberNoQuantity requested by the customer
lines[].unit_price_amountnumberNoUnit selling price
lines[].list_price_amountnumberNoUnit list or retail price
lines[].unit_cost_amountnumberNoUnit dealer cost
lines[].total_amountnumberNoExtended selling amount
lines[].total_cost_amountnumberNoExtended dealer cost
lines[].tax_amountnumberNo
metadataDmsMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].slugstringNoThe integration's API name (key) of an existing custom field.
metadata[].valueobjectNoThe field's value, typed by format.
metadata[].namespacestringNo
metadata[].formatenumNoThe 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_dataobjectNo

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"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot 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/partsale/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?