Order

Standard object representing a customer’s commitment, at a specific point in time, to buy products or services from your company. In Manufacturing Cloud, Automotive Cloud, and Consumer Goods Cloud orgs with the Advanced Orders feature, Order is extended with fields (such as OrderSpecId) that tie the order to an order-specification template and support field-sales/van-sales order-capture workflows. This object is available in API version 68.0 and later.

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

No additional setup or permissions beyond standard object- and field-level security are required to use the standard Order object. The Manufacturing/Automotive/Consumer Goods-specific extension fields on this object (for example OrderSpecId, and the van-sales/distribution fields such as DocumentType, DocumentTransactionType, IsDistributionRelevant, IsReleasedOnMobile) require the Advanced Orders or Retail Execution (Van Sales) features to be enabled and populated.

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The Account this order is for.

Relationship Name: Account

Refers To: Account

Type: reference

Properties: Filter, Group, Nillable, Sort, Update

Description: The User who activated this order.

Relationship Name: ActivatedBy

Refers To: User

Type: dateTime

Properties: Filter, Nillable, Sort, Update

Description: The date and time the order was activated.

Type: percent

Properties: Create, Filter, Nillable, Sort, Update

Description: The overall discount percentage applied to the order.

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The Account that receives the bill for this order, when different from the ordering Account.

Relationship Name: BillRecipientAccount

Refers To: Account

Type: address

Properties: Filter, Nillable

Description: A compound field containing the billing address components (city, country, state, street, postal code, and geolocation) for the order.

Type: string

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The city component of the order’s billing address.

Type: string

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The country component of the order’s billing address.

Type: picklist

Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description: The accuracy level of the billing address geolocation. Possible values are Address, Block, City, County, ExtendedZip, NearAddress, Neighborhood, State, Street, Unknown, and Zip.

Type: double

Properties: Create, Filter, Nillable, Sort, Update

Description: The latitude of the order’s billing address.

Type: double

Properties: Create, Filter, Nillable, Sort, Update

Description: The longitude of the order’s billing address.

Type: string

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The postal code component of the order’s billing address.

Type: string

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The state or province component of the order’s billing address.

Type: textarea

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The street component of the order’s billing address.

Type: picklist

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The reason the order was canceled.

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The User who authorized the order on behalf of your company.

Relationship Name: CompanyAuthorizedBy

Refers To: User

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The Contract associated with this order.

Relationship Name: Contract

Refers To: Contract

Type: picklist

Properties: Create, Defaulted on create, Filter, Group, 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.

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The Contact who authorized the order on behalf of the customer.

Relationship Name: CustomerAuthorizedBy

Refers To: Contact

Type: date

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The date on which the order’s products are expected to be delivered.

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The Account that receives the delivery for this order, when different from the ordering Account.

Relationship Name: DeliveryRecipientAccount

Refers To: Account

Type: textarea

Properties: Create, Nillable, Update

Description: A text description of the order.

Type: dateTime

Properties: Create, Filter, Nillable, Sort, Update

Description: The date and time the order document was released for processing or fulfillment.

Type: picklist

Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description: The transaction type of the order document. Used by Van Sales / direct-store-delivery order-capture flows. Possible values are CashInvoice, CashOrder, CreditInvoice, CreditMemo, CreditOrder, InvoiceCashInvoice, InvoiceCreditInvoice, NoPayment, NoPaymentOrder, NonValuatedDeliveryNote, ValuatedDeliveryNote, VanSalesCashInvoice, and VanSalesNoPaymentInvoice.

Type: picklist

Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description: The type of order document. Possible values are CashCheckIn, CashCheckOut, Delivery, Invoice, OrderEntry, ProductCheckIn, ProductCheckOut, and TruckAudit.

Type: date

Properties: Create, Filter, Group, Sort, Update

Description: The date on which the order goes into effect.

Type: date

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The date used to determine which pricing (price book, price adjustments, and Advanced Pricing conditions) is applicable to the order, when different from the order date.

Type: date

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The date the order ends.

Type: textarea

Properties: Create, Filter, Nillable, Sort, Update

Description: A note about the order that’s visible to external parties, such as the customer or a partner system.

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The Account responsible for fulfilling this order, when different from the ordering Account.

Relationship Name: FulfillmentAccount

Refers To: Account

Type: currency

Properties: Filter, Nillable, Sort

Description: The total amount of the order, including tax. This is a calculated, read-only field.

Type: string

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: An external identifier for the invoice associated with this order.

Type: boolean

Properties: Create, Defaulted on create, Filter, Group, Sort, Update

Description: Indicates whether this order is relevant to distribution/logistics processing. The default value is false.

Type: boolean

Properties: Defaulted on create, Filter, Group, Sort

Description: Sets the transaction as a large deal; this action can’t be reversed. The default value is false.

Type: boolean

Properties: Create, Defaulted on create, Filter, Group, Sort

Description: Indicates whether this order reduces the quantity or amount of a prior order (for example, a return or credit). The default value is false.

Type: boolean

Properties: Create, Defaulted on create, Filter, Group, Sort, Update

Description: Indicates whether the order was released for capture or fulfillment on a mobile device. The default value is false.

Type: dateTime

Properties: Filter, Nillable, Sort

Description: The timestamp when the current user last accessed this record, a related record, or a list view.

Type: dateTime

Properties: Filter, Nillable, Sort

Description: The timestamp when the current user last viewed this record.

Type: string

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: An external reference identifier linking this order to a record in an order-management system.

Type: string

Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort

Description: The auto-generated order number.

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The OrderSpec (order specification template) that this order was created from. Part of the Advanced Orders feature.

Relationship Name: OrderSpec

Refers To: OrderSpec

Type: reference

Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort

Description: The original Order that this order references, for example when this order is a change, return, or supplemental order.

Relationship Name: OriginalOrder

Refers To: Order

Type: reference

Properties: Create, Defaulted on create, Filter, Group, Sort, Update

Description: The User or Group that owns this order.

Relationship Name: Owner

Refers To: Group, User

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The Account responsible for paying for this order, when different from the ordering Account.

Relationship Name: PayerAccount

Refers To: Account

Type: string

Properties: Filter, Group, Nillable, Sort

Description: The waterfall execution identifier generated by the pricing procedure; used to display the price waterfall on the order header.

Type: reference

Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update

Description: The Pricebook2 associated with this order.

Relationship Name: Pricebook2

Refers To: Pricebook2

Type: reference

Properties: Filter, Group, Nillable, Sort

Description: A related Order, such as the order this one supersedes or supplements.

Relationship Name: RelatedOrder

Refers To: Order

Type: picklist

Properties: Filter, Group, Nillable, Restricted picklist, Sort

Description: The relationship type to the related order. Possible values are ChangeOrder, SupplementalOrder, and TransferOrder.

Type: double

Properties: Create, Filter, Nillable, Sort, Update

Description: The latitude at which the order was released (for example, captured or submitted) in the field.

Type: double

Properties: Create, Filter, Nillable, Sort, Update

Description: The longitude at which the order was released in the field.

Type: address

Properties: Filter, Nillable

Description: A compound field containing the shipping address components (city, country, state, street, postal code, and geolocation) for the order.

Type: string

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The city component of the order’s shipping address.

Type: string

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The country component of the order’s shipping address.

Type: picklist

Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description: The accuracy level of the shipping address geolocation. Possible values are Address, Block, City, County, ExtendedZip, NearAddress, Neighborhood, State, Street, Unknown, and Zip.

Type: double

Properties: Create, Filter, Nillable, Sort, Update

Description: The latitude of the order’s shipping address.

Type: double

Properties: Create, Filter, Nillable, Sort, Update

Description: The longitude of the order’s shipping address.

Type: string

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The postal code component of the order’s shipping address.

Type: string

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The state or province component of the order’s shipping address.

Type: textarea

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The street component of the order’s shipping address.

Type: picklist

Properties: Create, Filter, Group, Restricted picklist, Sort, Update

Description: The user-facing status of the order. Possible values are Activated and Draft.

Type: picklist

Properties: Filter, Group, Restricted picklist, Sort, Update

Description: The system status code of the order. Possible values are Activated, Canceled, Draft, Expired, and Superseded.

Type: currency

Properties: Create, Filter, Sort, Update

Description: The total amount of all order items on the order, excluding tax.

Type: currency

Properties: Filter, Nillable, Sort

Description: The sum of the rounded line amounts of the order’s order items. This is a calculated, read-only field.

Type: currency

Properties: Create, Filter, Nillable, Sort, Update

Description: The total tax amount for the order.

Type: picklist

Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update

Description: The type of order. Possible values are Indirect, Tele-Sales, and direct. The default value is direct.

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.