HIPE icon

HIPE

Interact with HIPE API

order → Update

AI-generated

Summary

Update an existing order by its ID with specified fields such as delivery dates, amounts, company association, status, tracking information, and custom fields.

Inputs

  • Order ID (required) — ID of the order to update.
  • Update Fields — Collection of fields to update on the order including dates (actualDeliveryDate, expectedDeliveryDate, orderDate, createdAt), billedAmount, companyId, createdById, currencyId, customFields (JSON object), externalId, projectId, shippingAddressId, statusId, trackingId.

Output shape

a single order record after update

Returns the updated order data reflecting the changes made. Errors are raised if the Order ID is invalid or the update fails.

Examples

Example 1: Updating the billed amount and expected delivery date for a specific order.

Provide the Order ID, then set the 'billedAmount' and 'expectedDeliveryDate' in Update Fields with new values.

Links

Discussion