--- schema_version: "1" id: fae2d9ed161f9449b9eb85347a2261e719f44d5a217c3e484989bf4ed1e1bf67 title: cgcloud__Order_Item__c collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/retail_api/sforce_api_objects_cgcloud__order_item__c.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__order_item__c.htm source_site: developer.salesforce.com content_type: documentation content_hash: 241b6bb3cd77173510498ccdf2db7404ba9a90beba508682fd64c17370917b8f description: Stores the details of the order item object. This object is available in API version 54.0 and later. --- # cgcloud\_\_Order\_Item\_\_c Stores the details of the order item object. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Base\_Price\_Receipt\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Basic product price in receipt currency. ### cgcloud\_\_Base\_Price\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Stores the Value of the item, specified in the appropriate product condition. ### cgcloud\_\_Check\_In\_Reason\_Code\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Allows the specification of a reason if the checked-in product quantity doesn't adhere to the expected product quantity that's given via product inventory. - **Possible values**: - Broken - Misc. - Miscounting—Miscounting Check Out - NoDoc—Pick up without doc. - Stolen ### cgcloud\_\_Consumer\_Quantity\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Ordered quantity expressed in consumer quantity units. ### cgcloud\_\_Discount\_\_c - **Type**: percent - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Manual discount given by the user. ### cgcloud\_\_Erp\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of this order entry for the ERP system. ### cgcloud\_\_Free\_Item\_Creation\_Step\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores a reference to the step that generates the free item. ### cgcloud\_\_Gross\_Value\_Receipt\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Gross value in receipt currency. ### cgcloud\_\_History\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The item, which has been added to the disposal list, has been ordered in a former sales document. (The item belongs to a former sales document of the same business partner and of the same sales document template.) - **Default value**: false ### cgcloud\_\_Left\_Quantity\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Item quantity that's left on the truck after product check-in. ### cgcloud\_\_Listed\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product exists in an authorization list of the order. - **Default value**: false ### cgcloud\_\_Modification\_Reason\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies a reason if preordered product quantity has been modified on the mobility device. - **Possible values**: - BadPrd—Bad Product - CpFailed—Pricing failed - DmgByDriver—Damage by driver - FGReturn—Full good return - IncOrder—Incorrect order - Less—Client wants less - Misc—Miscellaneous - MissCount—Misscounting - More—Client wants more - Nopayment—No payment - OutTrStock—Out of Truck Stock - TMStock—Too much stock - TckTransfer—Truck transfer - WrDel—Wrong delivery - WrongPrd—Wrong product ### cgcloud\_\_Order\_Item\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the order item template with which the Order Item is associated. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_Item\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Order\_Item\_Template\_\_c ### cgcloud\_\_Order\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: ID of the order with which the Order Item is associated. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Order\_\_c (Master object) ### cgcloud\_\_Out\_Of\_Stock\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the product is out of stock. - **Default value**: false ### cgcloud\_\_Parent\_Order\_Item\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to a parent Order Item. (For example, for a free item, the ordered item that caused the free item. It's used in complex pricing on mobility devices. This is a relationship field. - **Relationship Name**: cgcloud\_\_Parent\_Order\_Item\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Order\_Item\_\_c ### cgcloud\_\_Parent\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the parent to which the free item is related. It can be related to an Order Item. If the free item related to the Order header type is Order, then Parent\_Order\_Item is filled. - **Possible values**: - Item - Order - Reward ### cgcloud\_\_Price\_Receipt\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Calculated price of the item in the receipt or document currency. ### cgcloud\_\_Price\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Calculated price of the item in the domestic currency. ### cgcloud\_\_Pricing\_Info\_1\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field that stores the calculated value in the Order Item level. ### cgcloud\_\_Pricing\_Info\_2\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field for storing calculated value in the Order Item level. ### cgcloud\_\_Pricing\_Info\_3\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field for storing calculated value in the Order Item level. ### cgcloud\_\_Pricing\_Info\_4\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field for storing calculated value in the Order Item level. ### cgcloud\_\_Pricing\_Info\_5\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field for storing calculated value in the Order Item level. This field is available in API version 55.0 and later. ### cgcloud\_\_Pricing\_Info\_6\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field for storing calculated value in the Order Item level. This field is available in API version 55.0 and later. ### cgcloud\_\_Pricing\_Info\_7\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field for storing calculated value in the Order Item level. This field is available in API version 55.0 and later. ### cgcloud\_\_Pricing\_Info\_8\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field for storing calculated value in the Order Item level. This field is available in API version 55.0 and later. ### cgcloud\_\_Pricing\_Info\_9\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field for storing calculated value in the Order Item level. This field is available in API version 55.0 and later. ### cgcloud\_\_Pricing\_Info\_10\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field for storing calculated value in the Order Item level. This field is available in API version 55.0 and later. ### cgcloud\_\_Pricing\_Information\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores conditions that were used to calculate pricing. ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Product ID of the selected product. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Promoted\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a promotion is available in the relevant period. - **Default value**: false ### cgcloud\_\_Promotion\_Reward\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the reward that belongs to the Order Item. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_Reward\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_Reward\_\_c ### cgcloud\_\_Promotion\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the promotion if the product of the item originates from a selectable promotion. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_\_c ### cgcloud\_\_Quantity\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Quantity of this product. ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Hyperlink to the detail page of the record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Special\_Price\_Receipt\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies a reduced price for an item that's used to calculate the item value, if specified. This attribute can be edited only if the Order item template allows the consideration of the special price. ### cgcloud\_\_Special\_Price\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies a reduced price for an item that's used to calculate the item value, if specified. This attribute can be edited only if the sales document item template allows the consideration of the special price. ### cgcloud\_\_Suggested\_Quantity\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Contains the suggested order quantity that's been calculated via an algorithm or that's given by a relevant promotion. ### cgcloud\_\_Target\_Quantity\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Product checkout quantity for the tour that the HOST interface specifies. ### cgcloud\_\_UoM\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unit Of Measure. - **Possible values**: - ConsumerUnit - Layer - Pallet - SalesUnit ### cgcloud\_\_Value\_Receipt\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Calculated value of the item in the receipt or document currency. ### cgcloud\_\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Calculated value of the item in the domestic currency. ### cgcloud\_\_Voided\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a disposal list item is voided. - **Default value**: false ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, they are available in the same API versions as this object. Otherwise, they are available in the specified API version and later. - **[cgcloud\_\_Order\_Item\_\_cChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.")**: Change events are available for the object. - **[cgcloud\_\_Order\_Item\_\_cFeed](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.")**: Feed tracking is available for the object. - **[cgcloud\_\_Order\_Item\_\_cHistory](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.")**: History is available for the tracked fields of the object. - **[cgcloud\_\_Order\_Item\_\_cOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.")**: Sharing rules are available for the object. - **[cgcloud\_\_Order\_Item\_\_cShare](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.")**: Sharing is available for the object.