Represents an Advanced Orders line-item specification template — a reusable set of rules (quantity limits, logistics units, pricing impact, inventory and merchandise-limit behavior) that governs how a specific product or product family can be ordered under an OrderSpec. This object is available in API version 68.0 and later.
Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Special Access Rules
Available only in orgs with the Manufacturing Cloud or Automotive Cloud Advanced Orders feature enabled.
Fields
AllowQuantityModification
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies whether the ordered quantity can be modified from its default or recommended value, and in which direction. Possible values are No, None, OnlyDecrease, OnlyIncrease, and Yes.
CurrencyIsoCode
Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The ISO code for the currency of this record. Possible values are: AED (UAE Dirham), USD (U.S. Dollar), and every other active currency ISO code configured for the org. The default value is USD.
DefaultLogisticUnit
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The default logistics unit used when ordering. Possible values are ConsumerUnit, OrderUnit, PriceUnit, and StockTakingUnit.
DefaultScanUnit
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The default unit of measure assumed when a product is scanned during order capture. Possible values are ConsumerUnit, Layer, None, Pallet, and SalesUnit.
Description
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: A text description of the order item specification.
DisplaySequence
Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The sequence number that determines this specification's display order relative to other item specifications.
InternalOrganizationUnitId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The InternalOrganizationUnit this item specification is scoped to.
Relationship Name: InternalOrganizationUnit
Refers To: InternalOrganizationUnit
InventoryOverrunBehavior
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The system behavior when an order would exceed available inventory. Possible values are Allow, Block, and Warn.
IsActive
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether this order item specification is currently active. The default value is false.
IsClosedAuthorizationList
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the specification restricts orders to only products on a closed authorization list. The default value is false.
IsInventoryApplicable
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether inventory-availability checks apply to this item specification. The default value is false.
IsManualProdtAddAllowed
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether products can be manually added to the order outside the specification's default product list. The default value is false.
IsMdseLimitApplicable
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether merchandise-limit checks apply to this item specification. The default value is false.
IsOrderRoundingExcluded
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether this item specification is excluded from order-quantity rounding rules. The default value is false.
IsPriceOverriden
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the pricing engine price is overridden with a manually defined special price. The default value is false.
IsProdtDeliveryStateConsidered
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the product's delivery state is factored into order validation for this specification. The default value is false.
ItemPricingGroup
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The classification of the order item specification for pricing calculations. Possible values are Delivery, FreeItem, Return, and ReturnResale.
LastReferencedDate
Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last accessed this record, a related record, or a list view.
LastViewedDate
Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last viewed this record.
LogisticCategory
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The logistics category of the item specification. Possible values are None and Standard.
MaximumQuantity
Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The maximum quantity of the product that can be ordered under this specification.
MaximumQuantityValidationType
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies whether exceeding MaximumQuantity is blocked, allowed with a warning, or allowed outright. Possible values are No, Warning, and Yes.
MdseLimitOverrunBehavior
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The system behavior when an order would exceed a merchandise limit. Possible values are Allow, Block, and Warn.
ModificationReasonBehavior
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies whether a reason is required when the ordered quantity is modified. Possible values are Mandatory, NotRequired, and Optional.
MovementType
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The direction of inventory movement associated with this item specification. Possible values are In, None, and Out.
Name
Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: The name of the order item specification.
OwnerId
Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The User or Group that owns this record.
Relationship Name: Owner
Refers To: Group, User
PriceImpact
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The impact of the item specification on the total order value. Possible values are Additive, Neutral, and Subtractive.
QuantitySuggestionMethod
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The method used to suggest an ordered quantity to the buyer. Possible values are DeliveredQuantity, No, None, and OrderedQuantity.
ScanQuantityIncrement
Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The quantity increment applied each time the product is scanned during order capture.
ScanUnitBehavior
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The unit-of-measure behavior when scanning the product. Possible values are Barcode, Current, and Standard.
ShortDescription
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: A short text description of the order item specification.
ShouldAllowZeroQuantitySave
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether a line item with zero quantity can be saved under this specification. The default value is false.
UsageType
Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort
Description: The usage context of the order item specification, for example Retail.
Associated Objects
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 and later.
- OrderItemSpecChangeEvent: Change events are available for the object.
- OrderItemSpecFeed: Feed tracking is available for the object.
- OrderItemSpecHistory: History is available for tracked fields of the object.
- OrderItemSpecOwnerSharingRule: Sharing rules are available for the object.
- OrderItemSpecShare: Sharing is available for the object.