updatePriceQuote( )

Updates an existing price quote.

The updatePriceQuote() function returns a Promise that resolves to the updated price quote's ID and version when the price quote is updated.

If the existing price quote contains information that is not included in the updated price quote, that information is lost. For example, if a price quote contains metadata information, but when updating the quote no metadata information is sent, the updated quote will not have any metadata.

Note: The customer listed on the price quote must be an existing site contact or member.

Method Declaration
Copy
Method Parameters
idIdAndVersionRequired

ID and version of the price quote to update.

priceQuoteInfoPriceQuoteInfoRequired

The data used to update a price quote.

fieldMaskArray<string>

Fields to update in the price quote. If not specified, all fields update.

One of:

  • "customer"
  • "lineItems"
  • "number"
  • "locale"
  • "discount"
  • "title"
  • "currency"
  • "issueDate"
  • "dueDate"
  • "taxes"
  • "totals.total"
  • "totals.subtotal"
  • "totals.subtotal"
  • "totals.fees"
  • "metadata.notes"
  • "metadata.legalTerms"
  • "metadata.sourceUrl"
  • "metadata.sourceProperties"
  • "metadata.source"
  • "metadata.sourceRefId"
Returns
Return Type:Promise<Response>
Was this helpful?
Yes
No