OrderHistory

Represents historical information about changes that have been made to the standard fields of the associated order, or to any custom fields with history tracking enabled.

Supported Calls

getDeleted(), getUpdated(), query(), retrieve()

Fields

Field Name Details
Field
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Name of the order field that was modified, or a special value to indicate some other modification to the order.
NewValue
Type
anyType
Properties
Nillable, Sort
Description
New value of the modified order field. Maximum of 255 characters.
OldValue
Type
anyType
Properties
Nillable, Sort
Description
Previous value of the modified order field. Maximum of 255 characters.
OrderId
Type
reference
Properties
Filter, Group, Sort
Description
ID of the order associated with this record.

Usage

Order history entries are automatically created each time an order is modified.

Two rows are added to this record when foreign key fields change. One row contains the foreign key object names that display in the online application. For example, Jane Doe is recorded as the name of a Contact. The other row contains the actual foreign key ID that is only returned to and visible from the API.

This object respects field-level security on the parent object.

See Also