OrderSpec (Order Specification) is a top-level template used by the Advanced Orders feature to define the behavior and rules for a category of orders — such as which order types are allowed, how pricing is calculated and recalculated, how delivery dates and lead times are determined, and how inventory, promotions, and authorization lists are handled. Individual orders reference an OrderSpec (via the Order object's extension field) to inherit this configured behavior. 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
AllowedOrdererTypes
Type: multipicklist
Properties: Create, Filter, Nillable, Update
Description: The types of users or parties allowed to place orders under this order specification (for example, sales rep, customer self-service).
AuthorizationListFinding
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Determines how authorization list results are combined when validating whether a product can be ordered. Possible values are CombineAll—Combine All and FirstMatch—First Match.
BarcodeScanBehavior
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Determines what happens when a product barcode is scanned while building an order. Possible values are AddBatchNumber—Add Batch Number, OnlySelect—Only Select, SelectIncrease—Select and Increase, and UserExit—User Exit.
CanUpdatePurchaseNumber
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the purchase order number can be updated after the order is created. The default value is false.
CnclReasons
Type: multipicklist
Properties: Create, Filter, Nillable, Update
Description: The set of reasons that can be selected when an order under this order specification is canceled.
CreationPlatform
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The platform on which orders using this order specification can be created. Possible values are Both, Laptop, and Mobility.
CurrencyIsoCode
Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The ISO code for the currency of this order specification 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.
DeliveryDateCalculation
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Determines whether and how a delivery date is calculated for orders using this order specification. Possible values are None and Standard.
Description
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: A description of the order specification.
DisplaySequence
Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The display order of this order specification relative to other order specifications, for example in a picker UI.
DisposalListProposal
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Determines whether a disposal list proposal is generated for orders using this order specification. Possible values are None and Proposal.
DocumentTransactionType
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The transaction type of the resulting document (invoice, delivery note, and so on) generated from orders using this order specification. Possible values are CashInvoice, CashOrder, CreditInvoice, CreditMemo, CreditOrder, InvoiceCashInvoice, InvoiceCreditInvoice, NoPayment, NoPaymentOrder, NonValuatedDeliveryNote, ValuatedDeliveryNote, VanSalesCashInvoice, and VanSalesNoPaymentInvoice.
DocumentType
Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
Description: The type of document generated for orders using this order specification. Possible values are CashCheckIn, CashCheckOut, Delivery, Invoice, OrderEntry, ProductCheckIn, ProductCheckOut, and TruckAudit.
DoesAllowDlvrDateAdj
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the delivery date can be adjusted on orders using this order specification. The default value is false.
DoesAllowHdrDiscount
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether a header-level discount can be applied to orders using this order specification. The default value is false.
DoesIncludeFormerItem
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether previously ordered (former) items are included when building an order under this order specification. The default value is false.
IncludeAuthorizationList
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Determines whether an authorization list is applied when selecting products for orders using this order specification. Possible values are No, UserExit—User Exit, and Yes.
IncludeOutOfStock
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Determines whether out-of-stock products are included when building orders under this order specification. Possible values are Add, AddAndPresetQuantity—Add and Preset Quantity, No, and PresetQuantity—Preset Quantity.
IncludePromotions
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Determines whether promotions are considered for orders using this order specification. Possible values are No, UserExit—User Exit, and Yes.
InternalOrganizationUnitId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The internal organization unit associated with this order specification.
Relationship Name: InternalOrganizationUnit
Refers To: InternalOrganizationUnit
IsActive
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether this order specification is active and available for use on orders. The default value is false.
IsCnclReasonRequired
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether a cancellation reason is required when canceling an order under this order specification. The default value is false.
IsDeletionAllowed
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether orders using this order specification can be deleted. The default value is false.
IsFulfillmentAcctRequired
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether a fulfillment account is required on orders using this order specification. The default value is false.
IsInventoryFilterConsidered
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether inventory filters are applied when building orders under this order specification. The default value is false.
IsLocationAuthListEnabled
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether a location-based authorization list is enabled for orders using this order specification. The default value is false.
IsMobileRelevant
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether this order specification is relevant for mobile order-taking. The default value is false.
IsOrderSpecAsrmtFltrCsdn
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the order specification's assortment filter is considered when building orders. The default value is false.
IsOrderSpecAsrmtIncluded
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the order specification's assortment is included when determining orderable products. The default value is false.
IsPricingInfoStored
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the pricing information is stored on the order or order item. Used for printing and print previews. The default value is false.
IsPricingLogGenerated
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the pricing engine generates execution logs for this order type. The default value is false.
IsProdtFldStatusConsidered
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether product field status settings are considered when building orders under this order specification. The default value is false.
IsStockDisplayed
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether available stock is displayed to the user when building orders under this order specification. The default value is false.
LastReferencedDate
Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last accessed this record or a related record.
LastViewedDate
Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last viewed this record.
LookbackPeriodInDays
Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The number of days to look back at order history when applying rules (such as former-item inclusion) for this order specification.
MaxLeadTime
Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The maximum lead time, in days, allowed for orders using this order specification.
MaxOrderValue
Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The maximum total value allowed for an order using this order specification.
MinLeadTime
Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The minimum lead time, in days, required for orders using this order specification.
MinOrderValue
Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The minimum total value required for an order using this order specification.
MobileProductLevelGrouping
Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Determines how products are grouped when displayed on a mobile order-taking screen for this order specification.
Name
Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: The name of the order specification.
OwnerId
Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The user or queue that owns this order specification record.
Relationship Name: Owner
Refers To: Group, User
PriceCalcDateSource
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The base date used for complex price calculation. Possible values are DeliveryDate—Delivery Date and OrderDate—Order Date.
PricingRecalculationPolicy
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The recalculation behavior when the calculation date differs from the current date. Possible values are AlwaysCalculate—Always Calculate, No, Yes, and YesNotify—Yes Notify.
PricingType
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The pricing category of the order specification. Possible values are Contract, Donate, FreeOfCharge—Free of Charge, Refusal, Return, Sample, and Standard.
ReferencedApprovalStatus
Type: multipicklist
Properties: Create, Filter, Nillable, Update
Description: The approval statuses referenced by this order specification when evaluating whether an order can proceed.
ShouldAutoSelectPromotion
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether eligible promotions are automatically selected on orders using this order specification. The default value is false.
ShouldCaptrReleaseTime
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the release time is captured for orders using this order specification. The default value is false.
ShouldChkDeliveryDate
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the delivery date is validated when creating or updating orders under this order specification. The default value is false.
ShouldConsiderLeadTime
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether lead time is considered when calculating delivery dates for orders using this order specification. The default value is false.
ShouldConsiderSaturday
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether Saturday is treated as a working day when calculating dates for orders using this order specification. The default value is false.
ShouldConsiderSunday
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether Sunday is treated as a working day when calculating dates for orders using this order specification. The default value is false.
ShouldConsidrModReason
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether a modification reason must be considered when an order using this order specification is changed. The default value is false.
ShouldCustSlsDocTrxnType
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the customer's sales document transaction type is used for orders under this order specification. The default value is false.
ShouldIncludeInventory
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether inventory availability is included when building orders under this order specification. The default value is false.
SpecialOrderHandling
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Determines how special (non-standard) orders are handled under this order specification. Possible values are ExclusiveSpecialOrder—Exclusive Special Order, InclusiveSpecialOrder—Inclusive Special Order, and No.
SyncTriggerOption
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Determines what triggers synchronization for orders using this order specification. Possible values are Cancel, No, Release, and ReleaseCancel—Release and Cancel.
UsageType
Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort
Description: The usage category of this order specification. Possible values are Retail.
ValidFrom
Type: date
Properties: Create, Filter, Group, Sort, Update
Description: The date this order specification becomes valid and available for use.
ValidTo
Type: date
Properties: Create, Filter, Group, Sort, Update
Description: The date this order specification is no longer valid for use.
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.
- OrderSpecChangeEvent: Change events are available for the object.
- OrderSpecFeed: Feed tracking is available for the object.
- OrderSpecHistory: History is available for tracked fields of the object.
- OrderSpecOwnerSharingRule: Sharing rules are available for the object.
- OrderSpecShare: Sharing is available for the object.