Sales Orders
salesOrders Based on latest (2026.09)
Create, change, delete and look up Sales Orders, with sales order active version VA, sales order line and sales order rollup. Actions include create proposal and get quoting site URL.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE12 actions
- Record key
OrderHeaderId- Required on create
- none marked
- At a glance
- 55 fields5 finders7 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/salesOrders?fields=AccountBasedQuoteFlag,ActiveVersionFlag,BUOrgId,ContactPartyName,ContractEndDate&limit=25&onlyData=true
{
"items": [
{
"AccountBasedQuoteFlag": false,
"ActiveVersionFlag": false,
"BUOrgId": 0,
"ContactPartyName": "<string, max 360>",
"ContractEndDate": "2026-01-31T09:00:00+00:00"
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 55
| Attribute | Type | Use |
|---|---|---|
AccountBasedQuoteFlag | yes/no · max 1 | Optional on createUpdatable |
ActiveVersionFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
BUOrgId | number | Optional on createUpdatable |
ContactPartyName | text · max 360 | Read-only |
ContractEndDate | date-time | Optional on createUpdatableSearchable |
ContractStartDate | date-time | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-only |
CreationDate | date-time | Read-onlySearchable |
CrmConversionRate | number | Optional on createUpdatable |
CurrencyCode | text · max 15 | Optional on createUpdatable |
DeleteFlag | yes/no | Read-only |
Description | text · max 360 | Optional on createUpdatable |
ExpirationDate | date-time | Optional on createUpdatableSearchable |
ExternalHostName | text · max 255 | Optional on createUpdatable |
ExternalProcessName | text · max 255 | Optional on createUpdatable |
ExternalQuoteNumber | text · max 30 | Optional on createUpdatableSearchable |
ExternalReferenceNumber | text · max 64 | Optional on createUpdatable |
ExternalSystemReferenceCode | text · max 30 | Optional on createUpdatable |
LastOptySyncDate | date-time | Optional on createUpdatable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-only |
LastUpdatedBy | text · max 64 | Read-only |
Name | text · max 275 | Optional on createUpdatableSearchable |
OpportunityName | text · max 275 | Read-onlySearchable |
OptyId | number | Optional on createUpdatableSearchable |
OptyNumber | text · max 30 | Read-onlySearchable |
OptyStatusCd | text · max 30 | Read-onlySearchable |
OrderHeaderId | number | Optional on createSearchable |
OrderHeaderNumber | text · max 30 | Optional on createSearchable |
OrderTotal | number | Optional on createUpdatableSearchable |
Owner | text · max 360 | Optional on createUpdatable |
OwnerResourcePartyId | number | Optional on createUpdatable |
OwnerResourcePartyName | text · max 360 | Read-onlySearchable |
PlacedOnDate | date-time | Optional on createUpdatableSearchable |
ProposalExistFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ProposalUrl | text | Read-only |
QuoteTypeCategory | text · max 30 | Optional on createUpdatable |
RenewalProcess | text · max 30 | Optional on createUpdatable |
SalesAccountId | number | Optional on createUpdatable |
SalesAccountUniqueName | text · max 900 | Read-only |
SoldContactPartyId | number | Optional on createUpdatable |
SoldContactPartyNumber | text · max 30 | Read-onlySearchable |
SoldCustPartyNumber | text · max 30 | Read-onlySearchable |
SoldCustomerPartyId | number | Optional on createUpdatableSearchable |
SoldCustomerPartyUniqueName | text · max 900 | Read-onlySearchable |
SoldPartySiteId | number | Optional on createUpdatable |
Status | text · max 255 | Optional on createUpdatableSearchable |
TotalMonthlyRecurringRevenue | number | Optional on createUpdatable |
TotalMonthlyUsageRevenue | number | Optional on createUpdatable |
TotalNonRecurringRevenue | number | Optional on createUpdatable |
TotalRecurringRevenue | number | Optional on createUpdatable |
TotalUsageRevenue | number | Optional on createUpdatable |
UpdateFlag | yes/no | Read-only |
VersionNumber | number | Optional on createUpdatable |
WinStatusCode | text · max 30 · default ZCA_IN_PROGRESS | Optional on createUpdatableSearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 5
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
AltKey·ExternalReferenceNumberExternalSystemReferenceCodeCustQuotesRowFinder·SoldCustomerPartyIdOptyQuotesRowFinder·OptyIdSalesOrderAltKey·OrderHeaderNumberSalesOrderNumberAltKeyFinder·OrderHeaderNumber
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 7
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/<name>. Add them to a GET with expand.
SalesOrderActiveVersionVAGET · POST · PATCH · DELETE Sales Orders Active Version · 2 fields · 1 findersActiveVersionOrderHeaderIdSalesOrderLineGET · POST · PATCH · DELETE Quote and Order Lines · 63 fields · 1 findersAmountContractEndDateContractPeriodsContractStartDateContractValueCreatedByCreationDateCurrencyCodeDeleteFlagDescriptionDiscountPercentageExtReferenceNumberExternalAssetKeyExternalOrderLineIdExternalOrderLineNumberExternalParentAssetKeyExternalQuoteNumberExternalRootAssetKeyInventoryItemIdInventoryOrgIdItemNumberItemTypeCodeLastUpdateDateLastUpdateLoginLastUpdatedByLineStatusCodeMonthlyRecurringRevenueMonthlyUsageRevenueNonRecurringRevenueOptyIdOrderDateOrderHeaderIdOrderHeaderNameOrderHeaderNumberOrderLineIdOrderLineNumberOrderNumberParentExternalOrderLineNumberPricePricePeriodCodePriceTypeCodeQuantityRecurRevenueRequestDateRevenueTypeCategoryRevnIdRootLineSalesAccountIdSoldContactPartyIdSoldCustPartyIdSoldPartySiteIdSubscriptionIdSubscriptionLineIdSubtotalSummableContractAmountSummableNonRecurringRevenueSummableRecurringRevenueSummableUsageRevenueUOMCodeUnitListPriceUpdateFlagUsageRevenueWinLossStatusCodeSalesOrderRollupGET Quote Rollups · 7 fieldsCorpCurrencyCodeCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByOrderHeaderIdsmartActionsGET Smart Actions · 17 fieldsActionIntentConfirmationMessageContentTypeDisplayLabelEntityHrefIncludedInApplicationMassActionFlagMethodObjectFunctionNamePageTypeSmartSuggestFlagSystemActionFlagUpdateOfAttributesUserActionIdUserActionNameUserActionRankUserActionNavigationGET Smart Action User Interface Definitions · 5 fieldsSystemActionFlagUserActionNavAppUsageUserActionNavBodyUserActionNavIdUserActionNavTypeUserActionRequestPayloadGET Smart Action REST Payload Definitions · 8 fieldsBindingMandatoryFlagRequestPayloadIdRequestPayloadNameSmartSuggestPathSystemActionFlagValueValueStructUserActionURLBindingGET Smart Action REST Path Parameter Definitions · 5 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValue
Actions 12
POST …/action/createProposal·orderHeaderIdPOST …/action/getQuotingSiteURL·operationKeyorderHeaderIdPOST …/{OrderHeaderId}/child/SalesOrderLine/action/getIdValues·orderHeaderIdPOST …/{OrderHeaderId}/child/smartActions/action/executeActionForRows·payloadPOST …/{OrderHeaderId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{OrderHeaderId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{OrderHeaderId}/child/smartActions/action/getActionsForRows·payloadPOST …/{OrderHeaderId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{OrderHeaderId}/child/smartActions/action/getEntitiesPOST …/{OrderHeaderId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{OrderHeaderId}/child/smartActions/action/processMassAction·payloadPOST …/{OrderHeaderId}/child/smartActions/{UserActionId}/action/executeAction
Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/crmRestApi/resources/11.13.18.05/salesOrdersand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
AltKeyfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:AccountBasedQuoteFlag, notaccountbasedquoteflag. - 17 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.