ProductConsumed

Represents an item from your inventory that was used to complete a work order or work order line item in field service.

Introduced in API version 39.0.

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

  • Field Service must be enabled.

    To create products consumed, you need Read permission on product items.

    To delete or undelete product consumed for non-serialized products, you need Edit, Create, and Read permission on product consumed. For product consumed records that lookup to serialized products, you need Modify All Data or Modify All Records permission on product consumed.
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Notes and context about the product consumed.
  • Type: percent
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 51.0
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Introduced: API version 53.0
  • Description: Indicates that a product consumed has been processed if the Product2 it refers to has IsSerialized=true selected. The default is false.
  • Default value: false
  • Type: boolean
  • Properties: Defaulted on create, Filter, Group, Sort
  • Introduced: API version 55.0
  • Description: Indicates if a product is a serialized product. The default is false.
  • Default value: false
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 51.0
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Price book associated with the product consumed. If the work order and the product item’s associated product are related to the same price book, the Price Book Entry auto-populates based on the product item.
  • Relationship name: PricebookEntry
  • Relationship type: relationship
  • Refers to: PricebookEntry
  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Description: Product associated with the product consumed.
  • Relationship name: Product2
  • Relationship type: relationship
  • Refers to: Product2
  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: (Read Only) Auto-generated number identifying the product consumed.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort
  • Description: Product item associated with the product consumed. Creating a product consumed record subtracts the quantity consumed from the linked product item’s quantity.
  • Relationship name: ProductItem
  • Relationship type: relationship
  • Refers to: ProductItem
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Description: Name for the product consumed.
  • Type: double
  • Properties: Create, Filter, Sort, Update
  • Description: The quantity of products consumed.
  • Type: picklist
  • Properties: Filter, Group, Nillable, Sort
  • Description: Units of the consumed item; for example, kilograms or liters. Quantity Unit of Measure picklist values are inherited from the Quantity Unit of Measure field on products.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 51.0
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 51.0
  • Description: The total price paid for the product items.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The price per unit of the product consumed.
  • Type: reference
  • Properties: Create, Filter, Group, Sort
  • Description: Work order that the product was consumed for.
  • Relationship name: WorkOrder
  • Relationship type: masterdetail
  • Refers to: WorkOrder
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Work order line item that the product was consumed for.
  • Relationship name: WorkOrderLineItem
  • Relationship type: relationship
  • Refers to: WorkOrderLineItem

When a product is consumed during the completion of a work order, create a product consumed record to track its consumption. You can add products consumed to work orders or work order line items. Track product consumption at the line item level if you want to know which products were used for each line item’s tasks.

The way you use products consumed depends on how closely you want to track the state of your inventory in Salesforce. If you want to track the entire lifecycle of items in your inventory, including their storage, transfer, and consumption, link your products consumed records to product items. This approach ensures that your inventory numbers auto-update to reflect the consumption of products from your inventory. If you want to track product consumption only, however, specify a Price Book Entry on each product consumed record and leave the Product Item field blank.

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.