Sales Orders for Order Hub
salesOrdersForOrderHub Based on 26C
Create, change, delete and look up Sales Orders for Order Hub, with additional information, bill to customer and copy order reference. Actions include apply hold and release hold.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE5 actions
- Record key
OrderKey- Required on create
BusinessUnitIdSourceTransactionIdSourceTransactionNumberSourceTransactionRevisionNumberSourceTransactionSystem- At a glance
- 126 fields5 finders51 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub?fields=AgreementHeaderId,AgreementNumber,AgreementVersionNumber,AllowCurrencyOverrideFlag,AppliedCurrencyCode&limit=25&onlyData=true
{
"items": [
{
"AgreementHeaderId": 0,
"AgreementNumber": "<string, max 255>",
"AgreementVersionNumber": 0,
"AllowCurrencyOverrideFlag": false,
"AppliedCurrencyCode": "<string, max 15>"
}
],
"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 26C REST specification.
Fields 126
| Attribute | Type | Use |
|---|---|---|
AgreementHeaderId | number | Optional on createUpdatableSearchable |
AgreementNumber | text · max 255 | Optional on createUpdatableSearchable |
AgreementVersionNumber | number | Read-onlySearchable |
AllowCurrencyOverrideFlag | yes/no · max 1 | Optional on createUpdatable |
AppliedCurrencyCode | text · max 15 | Read-onlySearchable |
AppliedCurrencyName | text · max 255 | Read-only |
BillingSetFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
BusinessUnitId | number | Required on createSearchable |
BusinessUnitName | text · max 255 | Optional on create |
BuyingPartyContactEmail | text · max 255 | Optional on createUpdatable |
BuyingPartyContactFirstName | text · max 255 | Optional on createUpdatable |
BuyingPartyContactId | number | Optional on createUpdatableSearchable |
BuyingPartyContactLastName | text · max 255 | Optional on createUpdatable |
BuyingPartyContactMiddleName | text · max 255 | Optional on createUpdatable |
BuyingPartyContactName | text · max 255 | Optional on createUpdatable |
BuyingPartyContactNameSuffix | text · max 255 | Optional on createUpdatable |
BuyingPartyContactNumber | text · max 255 | Optional on createUpdatable |
BuyingPartyContactTitle | text · max 255 | Optional on createUpdatable |
BuyingPartyEmail | text · max 255 | Optional on createUpdatable |
BuyingPartyId | number | Optional on createUpdatableSearchable |
BuyingPartyName | text · max 255 | Optional on createUpdatable |
BuyingPartyNumber | text · max 255 | Optional on createUpdatable |
BuyingPartyPersonFirstName | text · max 255 | Optional on createUpdatable |
BuyingPartyPersonLastName | text · max 255 | Optional on createUpdatable |
BuyingPartyPersonMiddleName | text · max 255 | Optional on createUpdatable |
BuyingPartyPersonNameSuffix | text · max 255 | Optional on createUpdatable |
BuyingPartyPersonTitle | text · max 255 | Optional on createUpdatable |
CancelReason | text · max 255 | Optional on createUpdatable |
CancelReasonCode | text · max 255 | Optional on createUpdatable |
CanceledFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
Comments | text · max 2000 | Optional on createUpdatable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
CurrencyConversionDate | date-time | Optional on createUpdatable |
CurrencyConversionRate | number | Optional on createUpdatable |
CurrencyConversionType | text · max 30 | Optional on createUpdatable |
CustomerPONumber | text · max 50 | Optional on createUpdatableSearchable |
DemandClass | text · max 255 | Optional on createUpdatable |
DemandClassCode | text · max 255 | Optional on createUpdatable |
EarliestAcceptableShipDate | date-time | Optional on createUpdatableSearchable |
FOBPoint | text · max 255 | Optional on createUpdatable |
FOBPointCode | text · max 255 | Optional on createUpdatable |
FreezePriceFlag | yes/no · max 1 · default true | Optional on createUpdatable |
FreezeShippingChargeFlag | yes/no · max 1 · default true | Optional on createUpdatable |
FreezeTaxFlag | yes/no · max 1 · default true | Optional on createUpdatable |
FreightTerms | text · max 255 | Optional on createUpdatable |
FreightTermsCode | text · max 255 | Optional on createUpdatable |
HeaderId | number | Optional on createSearchable |
IsHeaderUpdatableByCurrentUserFlag | yes/no · max 1 | Read-onlySearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
LatestAcceptableArrivalDate | date-time | Optional on createUpdatableSearchable |
LatestAcceptableShipDate | date-time | Optional on createUpdatableSearchable |
MessageText | text | Read-onlySearchable |
OnHoldFlag | yes/no · max 1 · default false | Read-onlySearchable |
OpenFlag | yes/no · max 1 · default true | Read-onlySearchable |
OrderKey | text · max 255 | Optional on createUpdatableSearchable |
OrderNumber | text · max 50 · default -1 | Read-onlySearchable |
OrderRepresentative | text · max 255 | Read-only |
OrderRepresentativeUsername | text · max 100 | Optional on createUpdatableSearchable |
OrigSystemDocumentReference | text · max 50 | Optional on createUpdatableSearchable |
PackingInstructions | text · max 1000 | Optional on createUpdatableSearchable |
PartialShipAllowedFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
PaymentTerms | text · max 255 | Optional on createUpdatable |
PaymentTermsCode | number | Optional on createUpdatable |
PreCreditCheckedFlag | yes/no · max 1 · default false | Optional on createUpdatable |
PreferredSoldToContactPointId | number | Optional on createUpdatableSearchable |
PricedOn | date-time | Optional on createUpdatableSearchable |
PricingDate | date-time | Optional on createUpdatableSearchable |
PricingSegment | text · max 255 | Read-onlySearchable |
PricingSegmentCode | text · max 30 | Optional on createUpdatable |
PricingSegmentExplanation | text · max 1000 | Optional on createUpdatable |
PricingStrategyExplanation | text · max 1000 | Optional on createUpdatable |
PricingStrategyId | number | Optional on createUpdatable |
PricingStrategyName | text · max 255 | Optional on createUpdatable |
RequestedArrivalDate | date-time | Optional on createUpdatableSearchable |
RequestedCancelDate | date-time | Optional on createUpdatableSearchable |
RequestedFulfillmentOrganizationCode | text · max 255 | Optional on createUpdatable |
RequestedFulfillmentOrganizationId | number | Optional on createUpdatableSearchable |
RequestedFulfillmentOrganizationName | text · max 255 | Optional on createUpdatable |
RequestedShipDate | date-time | Optional on createUpdatableSearchable |
RequestingBusinessUnitId | number | Optional on createSearchable |
RequestingBusinessUnitName | text · max 255 | Optional on create |
RequestingLegalEntity | text · max 255 | Optional on createUpdatable |
RequestingLegalEntityId | number | Optional on createUpdatableSearchable |
RevisionSourceSystem | text · max 30 | Optional on createUpdatableSearchable |
SalesChannel | text · max 255 | Optional on createUpdatable |
SalesChannelCode | text · max 30 | Optional on createUpdatableSearchable |
Salesperson | text · max 255 | Optional on createUpdatable |
SalespersonId | number | Optional on createUpdatableSearchable |
SegmentExplanationMessageName | text · max 30 | Optional on createUpdatable |
ShipmentPriority | text · max 255 | Optional on createUpdatable |
ShipmentPriorityCode | text · max 255 | Optional on createUpdatable |
ShippingCarrier | text · max 255 | Optional on createUpdatable |
ShippingCarrierId | number | Optional on createUpdatable |
ShippingInstructions | text · max 1000 | Optional on createUpdatableSearchable |
ShippingMode | text · max 255 | Optional on createUpdatable |
ShippingModeCode | text · max 255 | Optional on createUpdatable |
ShippingServiceLevel | text · max 255 | Optional on createUpdatable |
ShippingServiceLevelCode | text · max 255 | Optional on createUpdatable |
ShipsetFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
SourceTransactionId | text · max 50 | Required on createSearchable |
SourceTransactionNumber | text · max 50 | Required on createSearchable |
SourceTransactionRevisionNumber | number | Required on createUpdatableSearchable |
SourceTransactionSystem | text · max 50 | Required on createSearchable |
Status | text · max 255 | Read-only |
StatusCode | text · max 30 · default OPEN | Read-onlySearchable |
StrategyExplanationMessageName | text · max 30 | Optional on createUpdatable |
SubmittedBy | text · max 64 | Read-onlySearchable |
SubmittedDate | date-time | Read-onlySearchable |
SubmittedFlag | yes/no · max 1 · default true | Optional on createUpdatableSearchable |
SubstituteAllowedFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
SupplierId | number | Optional on createUpdatable |
SupplierName | text · max 255 | Optional on createUpdatable |
SupplierNumber | text · max 255 | Optional on createUpdatableSearchable |
SupplierSiteId | number | Optional on createUpdatableSearchable |
SupplierSiteName | text · max 255 | Optional on createUpdatable |
TradeComplianceResult | text · max 255 | Read-only |
TradeComplianceResultCode | text · max 30 | Read-only |
TransactionDocumentTypeCode | text · max 50 | Optional on createUpdatableSearchable |
TransactionOn | date-time | Optional on createUpdatableSearchable |
TransactionType | text · max 255 | Optional on createUpdatable |
TransactionTypeCode | text · max 30 | Optional on createUpdatableSearchable |
TransactionalCurrencyCode | text · max 15 | Optional on createUpdatableSearchable |
TransactionalCurrencyName | text · max 255 | Optional on createUpdatable |
UserConversionType | text · max 30 | Optional on createUpdatableSearchable |
Names, types, labels and flags from Oracle's REST specification (26C). 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.
findByHeaderId·HeaderIdfindByOrderKey·OrderKeyfindByOrderNumber·OrderNumberfindByOrderedDate·FromDateToDatefindBySourceOrderNumberAndSystem·SourceTransactionNumberSourceTransactionSystem
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 51
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/<name>. Add them to a GET with expand.
additionalInformationGET · POST · PATCH DetailsFields depend on your pod's flexfield setup (check
/describe).attachmentsGET · POST · PATCH Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamebillToCustomerGET · POST · PATCH Bill-to Customers · 32 fields · 2 findersAccountNumberAddress1Address2Address3Address4AddressIdCityContactEmailContactFirstNameContactIdContactLastNameContactMiddleNameContactNameContactNameSuffixContactNumberContactTitleCountryCountyCustomerAccountIdPartyEmailPartyNamePersonFirstNamePersonLastNamePersonMiddleNamePersonNameSuffixPersonTitlePostalCodePreferredContactPointIdProvinceSiteUseIdSourceAddressIdStatecopyOrderReferenceGET Copy Orders · 4 fieldsDocumentSystemReferenceIdOriginalHeaderIdOriginalOrderChangeVersionNumberOriginalOrderNumberholdsGET Holds · 14 fieldsActiveFlagApplyDateApplySystemApplyUserHoldCodeHoldCommentsHoldInstanceIdHoldNameHoldReleaseCommentsHoldReleaseReasonHoldReleaseReasonCodeReleaseDateReleaseUserSourceRequestIdlinesGET · POST · PATCH Order Lines · 337 fields · 2 findersAccountingRuleAccountingRuleCodeActionTypeActionTypeCodeActualCompletionDateActualShipDateAgreementHeaderIdAgreementLineIdAgreementLineNumberAgreementNumberAgreementVersionNumberAppliedPriceListIdAppliedPriceListNameAssessableValueAssetGroupNumberAssetTrackedFlagAssetTrackingAssetTrackingCodeAttachToSubscriptionBillingSetIdBillingSetNameBillingSetStatusBillingSetStatusCodeBillingTransactionTypeIdBillingTransactionTypeNameBusinessUnitIdBusinessUnitNameBuyerFirstNameBuyerIdBuyerLastNameBuyerMiddleNameBuyerNameCancelBackordersFlagCancelReasonCancelReasonCodeCanceledFlagCanceledQuantityCommentsComponentIdPathConfigCreationDateConfigHeaderIdConfigInventoryItemDescriptionConfigInventoryItemIdConfigInventoryItemNumberConfigItemReferenceConfigItemVersionConfigRevisionNumberConfigTradeComplianceResultConfigTradeComplianceResultCodeConfiguratorPathContractEndDateContractEndDateTimeContractStartDateContractStartDateTimeCoveredCustomerProductDescriptionCoveredCustomerProductIdCoveredCustomerProductNumberCoveredProductDescriptionCoveredProductIdCoveredProductNumberCreatedByCreationDateCreditCheckAuthExpiryDateCreditCheckAuthorizationNumberCustomerPOLineNumberCustomerPONumberCustomerPOScheduleNumberCustomerProductDescriptionCustomerProductIdCustomerProductNumberDefaultTaxationCountryDefaultTaxationCountryShortNameDemandClassDemandClassCodeDemandSourceLineReferenceDemandSourceScheduledFlagDestinationLocationIdDestinationShippingOrganizationCodeDestinationShippingOrganizationIdDestinationShippingOrganizationNameDisplayLineNumberDocumentSubtypeDocumentSubtypeNameEarliestAcceptableShipDateEndCreditMethodEndCreditMethodCodeEndDateEndReasonEndReasonCodeEnforceSingleShipmentFlagEstimateFulfillmentCostEstimateMarginExemptionCertificateNumberExtendedAmountExternalPriceBookNameFOBPointFOBPointCodeFinalDischargeLocationAddressCityFinalDischargeLocationAddressCountryFinalDischargeLocationAddressCountyFinalDischargeLocationAddressLine1FinalDischargeLocationAddressLine2FinalDischargeLocationAddressLine3FinalDischargeLocationAddressLine4FinalDischargeLocationAddressPostalCodeFinalDischargeLocationAddressProvinceFinalDischargeLocationAddressStateFinalDischargeLocationIdFirstPartyTaxRegistrationFirstPartyTaxRegistrationNumberFreightTermsFreightTermsCodeFulfillInstanceIdFulfillLineIdFulfillLineNumberFulfilledQuantityFulfillmentDateFulfillmentModeFulfillmentSplitReferenceIdGopReferenceIdGopRequestRegionHeaderIdIntegrateSubscriptionFlagIntendedUseClassificationIdIntendedUseClassificationNameInventoryInterfacedFlagInventoryOrganizationCodeInventoryOrganizationIdInventoryOrganizationNameInventoryTransactionFlagInvoiceEnabledFlagInvoiceInterfaceStatusInvoiceInterfaceStatusCodeInvoiceInterfacedFlagInvoiceableItemFlagInvoicingRuleInvoicingRuleCodeItemSubTypeItemSubTypeCodeItemTypeCodeJeopardyPriorityJeopardyPriorityCodeLastUpdateDateLastUpdateLoginLastUpdatedByLatestAcceptableArrivalDateLatestAcceptableShipDateLineIdLineNumberOnHoldFlagOneTimeConfigFlagOpenFlagOrchestrationProcessNameOrderedQuantityOrderedUOMOrderedUOMCodeOrigSystemDocumentLineReferenceOrigSystemDocumentReferenceOriginalProductDescriptionOriginalProductIdOriginalProductNumberOverFulfillmentToleranceOverrideScheduleDateFlagOwnerIdPOStatusCodePackingInstructionsParentFulfillLineIdParentSourceTransactionLineIdPartialShipAllowedFlagPaymentTermsPaymentTermsCodePriceUsingSecondaryUOMFlagPricedOnProcessNumberProductCategoryProductCategoryNameProductDescriptionProductFiscalCategoryProductFiscalCategoryIdProductIdProductNumberProductTypeProductTypeNamePromiseArrivalDatePromiseShipDatePromotionItemFlagPurchasingEnabledFlagPurchasingUOMPurchasingUOMCodeQuantityForEachModelRMADeliveredQuantityRatePlanDocumentRatePlanDocumentIdRatePlanIdRatePlanNameRatePlanNumberReceivablesOrgIdReceivablesOrgNameRemnantFlagRequestedArrivalDateRequestedCancelDateRequestedFulfillmentOrganizationAddress1RequestedFulfillmentOrganizationAddress2RequestedFulfillmentOrganizationAddress3RequestedFulfillmentOrganizationAddress4RequestedFulfillmentOrganizationCityRequestedFulfillmentOrganizationCodeRequestedFulfillmentOrganizationCountryRequestedFulfillmentOrganizationCountyRequestedFulfillmentOrganizationIdRequestedFulfillmentOrganizationNameRequestedFulfillmentOrganizationPostalCodeRequestedFulfillmentOrganizationProvinceRequestedFulfillmentOrganizationStateRequestedRatePlanIdRequestedRatePlanNameRequestedRatePlanNumberRequestedShipDateRequestingBusinessUnitIdRequestingBusinessUnitNameRequiredFulfillmentDateRequisitionBusinessUnitIdRequisitionBusinessUnitNameRequisitionInventoryOrganizationCodeRequisitionInventoryOrganizationIdRequisitionInventoryOrganizationNameReservableFlagReservationIdReservedQuantityReturnReasonReturnReasonCodeReturnableFlagRootParentFulfillLineIdSalesProductTypeSalesProductTypeCodeSalespersonSalespersonIdScheduleArrivalDateScheduleShipDateSchedulingReasonSchedulingReasonCodeSecondaryFulfilledQuantitySecondaryOrderedQuantitySecondaryRMADeliveredQuantitySecondaryShippedQuantitySecondaryUOMSecondaryUOMCodeSellingProfitCenterBusinessUnitIdSellingProfitCenterBusinessUnitNameServiceCancelDateServiceDurationServiceDurationPeriodCodeServiceDurationPeriodNameShipSetNameShipmentPriorityShipmentPriorityCodeShippableFlagShippedQuantityShippedUOMShippedUOMCodeShippingCarrierShippingCarrierIdShippingInstructionsShippingModeShippingModeCodeShippingServiceLevelShippingServiceLevelCodeShowInSalesSortSequenceNumberSourceScheduleNumberSourceTransactionIdSourceTransactionLineIdSourceTransactionLineNumberSourceTransactionNumberSourceTransactionRevisionNumberSourceTransactionScheduleIdSourceTransactionSystemSplitFromFlineIdStatusStatusCodeSubinventorySubinventoryCodeSubscriptionInterfacedFlagSubscriptionProfileIdSubscriptionProfileNameSubstitutionAllowedFlagSubstitutionReasonSubstitutionReasonCodeSupplierAddress1SupplierAddress2SupplierAddress3SupplierAddress4SupplierCitySupplierCountrySupplierCountySupplierIdSupplierNameSupplierNumberSupplierPostalCodeSupplierProvinceSupplierSiteIdSupplierSiteNameSupplierStateSupplyStatusCodeTaxClassificationTaxClassificationCodeTaxExemptTaxExemptCodeTaxExemptFlagTaxExemptReasonTaxExemptReasonCodeTaxInvoiceDateTaxInvoiceNumberThirdPartyTaxRegistrationThirdPartyTaxRegistrationNumberTotalContractAmountTotalContractQuantityTradeComplianceDateTradeComplianceResultTradeComplianceResultCodeTransactionBusinessCategoryTransactionBusinessCategoryNameTransactionCategoryCodeTransactionLineTypeTransactionLineTypeCodeTransformFromLineIdTransportationPlannedFlagTransportationPlannedStatusCodeTransportationPlanningOrderUnderFulfillmentToleranceUnitListPriceUnitQuantityUnitSellingPriceUnreferencedReturnFlagUserDefinedFiscalClassUserDefinedFiscalClassNameValidConfigurationFlagadditionalInformationGET · POST · PATCH DetailsFields depend on your pod's flexfield setup (check
/describe).amendSubscriptionReferencesGET · POST · PATCH Amend Subscription References · 4 fieldsExternalAssetKeyExternalParentAssetKeyExternalRootParentAssetKeySubscriptionProductPuidassetTransactionDetailsGET · POST Asset Transaction Details · 19 fields · 1 findersAssetIdAssetNumberAssetTransactionActionAssetTransactionActionCodeAssetTransactionDetailIdAssetUOMAssetUOMCodeCreatedByCreationDateCustomerAssetEndDateFulfillLineIdLastUpdateDateLastUpdateLoginLastUpdatedByQuantitySourceAssetTransactionDetailIdStatusStatusCodeStatusIdassociatedProductReferencesGET · POST · PATCH Associated Product Items · 10 fieldsAssociatedProductFulfillLineIdAssociatedProductHeaderIdAssociatedProductItemNumberDisplayLineNumberOrderNumberSourceLineIdSourceLineNumberSourceOrderIdSourceOrderNumberSourceOrderSystemattachmentsGET · POST · PATCH Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamebillToCustomerGET · POST · PATCH Bill-to Customers · 33 fields · 1 findersAccountDescriptionAccountNumberAddress1Address2Address3Address4AddressIdCityContactEmailContactFirstNameContactIdContactLastNameContactMiddleNameContactNameContactNameSuffixContactNumberContactTitleCountryCountyCustomerAccountIdPartyEmailPartyNamePersonFirstNamePersonLastNamePersonMiddleNamePersonNameSuffixPersonTitlePostalCodePreferredContactPointIdProvinceSiteUseIdSourceAddressIdStatebillingPlansGET · POST · PATCH Billing Plans · 16 fields · 1 findersBillingNumberOfPeriodsBillingPeriodEndDateBillingPeriodNumberBillingPeriodStartDateBillingPlanIdBillingPlanTypeBillingPlanTypeCodeBillingTransactionDateCancellationEffectiveDateNetBillingAmountForEachPeriodOverridePeriodOverridePeriodAmountOverridePeriodQuantityPeriodicityPeriodicityCodeSourceBillingPlanIdchannelProgramsGET Channel Programs · 27 fields · 1 findersApplyTypeCommentsDeclinableFlagDeclineReasonDeclineReasonCodeDiscountAmountDiscountTypeDiscountTypeCodeEndDateIncentiveEntitySubtypeCodeIncentiveEntityTypeCodeIncentiveIdItemLevelItemLevelCodeManuallyAppliedFlagProgramCodeProgramDescriptionProgramDetailsProgramIdProgramLineProgramLineIdProgramNameProgramTypeNameSourceIncentiveIdStartDateStatusStatusCodechargesGET · POST · PATCH Charges · 36 fields · 2 findersApplyToApplyToCodeAverageUnitSellingPriceBlockAllowanceBlockSizeCanAdjustFlagChargeCurrencyChargeCurrencyCodeChargeDefinitionChargeDefinitionCodeChargePeriodChargePeriodCodeChargeSubTypeChargeSubtypeCodeChargeTypeChargeTypeCodeGSAUnitPriceOrderChargeIdPricePeriodicityPricePeriodicityCodePriceTypePriceTypeCodePricedQuantityPricedQuantityUOMPricedQuantityUOMCodePrimaryFlagPromotionItemTermIdRollupFlagSequenceNumberSourceChargeIdTierAppliesToTierAppliesToCodeTieredFlagUsagePriceLockFlagUsageUOMUsageUOMCodechargeComponentsGET · POST · PATCH Charge Components · 29 fields · 2 findersChargeCurrencyChargeCurrencyCodeChargeCurrencyDurationExtendedAmountChargeCurrencyExtendedAmountChargeCurrencyUnitPriceExplanationExplanationMessageNameHeaderCurrencyHeaderCurrencyCodeHeaderCurrencyDurationExtendedAmountHeaderCurrencyExtendedAmountHeaderCurrencyUnitPriceOrderChargeComponentIdPercentOfComparisonElementPriceElementPriceElementCodePriceElementUsagePriceElementUsageCodePricingSourceIdPricingSourceTypePricingSourceTypeCodePromotionCodePromotionIdPromotionLineIdRollupFlagSequenceNumberSourceChargeComponentIdSourceMpaIdTaxIncludedFlagtotalComponentsGET Total Components · 10 fieldsHeaderCurrencyCodeHeaderCurrencyExtendedAmountHeaderCurrencyNameOrderChargeComponentIdOrderTotalComponentIdOrderTotalIdPriceElementPriceElementCodePriceElementUsagePriceElementUsageCodechargeTiersGET · POST · PATCH Charge Tiers · 10 fields · 1 findersAdjustmentAmountApplicationMethodApplicationMethodCodeBlockSizeOrderChargeIdOrderChargeTierIdSourceOrderChargeTierIdTierFromTierSequenceNumberTierTocoverageReferencesGET Coverage Items · 7 fieldsCoverageFulfillLineIdCoverageItemNumberDisplayLineNumberHeaderIdOrderNumberSourceLineNumberSourceOrderNumbercoveredAssetReferenceGET · POST · PATCH Covered Assets · 2 fieldsCoveredAssetIdCoveredAssetNumbercoveredProductReferencesGET · POST · PATCH Covered Items · 10 fieldsCoveredFulfillLineIdCoveredItemNumberDisplayLineNumberHeaderIdOrderNumberSourceLineIdSourceLineNumberSourceOrderIdSourceOrderNumberSourceOrderSystemdropShipPurchaseOrderReferenceGET Drop Ships · 5 fieldsDocumentSystemReferenceIdPOHeaderIdPOLineIdPOLineLocationIdPONumberdropShipRequisitionReferenceGET Drop Ship Requisitions · 5 fieldsDocumentSystemReferenceIdRequisitionHeaderIdRequisitionLineIdRequisitionLineNumberRequisitionNumberexternalAssetReferenceGET · POST · PATCH External Asset References · 4 fieldsExternalAssetKeyExternalParentAssetKeyExternalRootParentAssetKeySubscriptionProductPuidexternalFulfillmentSalesOrderReferenceGET Fulfillment Orders · 4 fieldsDocumentIdDocumentLineNumberDocumentNumberDocumentSystemReferenceIdholdsGET Holds · 14 fieldsActiveFlagApplyDateApplySystemApplyUserHoldCodeHoldCommentsHoldInstanceIdHoldNameHoldReleaseCommentsHoldReleaseReasonHoldReleaseReasonCodeReleaseDateReleaseUserSourceRequestIdinternalOrderReferenceGET Internal Sales Orders · 2 fieldsDocumentSystemReferenceIdInternalOrderDocumentTypelineDetailsGET Line Details · 28 fieldsActualDeliveryDateAvailabilityShipDateBillOfLadingNumberBillingTransactionAmountBillingTransactionDateBillingTransactionNumberCustomerTransactionLineIdDeliveryNameExceptionFlagFulfillLineDetailIdQuantityRMAReceiptDateRMAReceiptDateTimeRMAReceiptLineNumberRMAReceiptNumberRMAReceiptTransactionIdSecondaryQuantityStatusStatusAsOfDateStatusCodeTaskTypeTrackingNumberTradeComplianceCodeTradeComplianceExplanationTradeComplianceResultCodeTradeComplianceTypeTradeComplianceTypeCodeWaybillNumberlotSerialsGET · POST · PATCH Lot Serials · 11 fields · 3 findersDeletedFlagItemRevisionNumberItemSerialNumberFromItemSerialNumberToLocatorLocatorIdLotNumberLotSerialIdQuantitySecondaryQuantitySourceLotSerialIdmanualPriceAdjustmentsGET · POST · PATCH Manual Price Adjustments · 23 fields · 1 findersAdjustmentAmountAdjustmentElementBasisAdjustmentElementBasisNameAdjustmentTypeAdjustmentTypeCodeChargeDefinitionChargeDefinitionCodeChargeRollupFlagCommentsEffectiveNumberOfPeriodsEffectivePeriodFromEffectivePeriodUntilEffectivityTypeEffectivityTypeCodeManualPriceAdjustmentIdParentEntityIdPricePeriodicityPricePeriodicityCodeReasonReasonCodeSequenceNumberSourceManualPriceAdjustmentIdValidationStatusCodenotesGET · POST · PATCH Notes · 6 fieldsDescriptionNoteIdNoteTypeCodeNoteTypeMeaningTextTitleoriginalOrderReferenceGET · POST · PATCH Original Orders · 10 fieldsOriginalFulfillLineIdOriginalHeaderIdOriginalItemLineNumberOriginalItemNumberOriginalOrderNumberOriginalSourceLineIdOriginalSourceLineNumberOriginalSourceOrderIdOriginalSourceOrderNumberOriginalSourceOrderSystempaymentsGET · POST · PATCH Payments · 31 fields · 1 findersAmountAuthorizationRequestIdAuthorizationStatusAuthorizationStatusCodeAuthorizedAmountAuthorizedInSourceFlagAuthorizedOnCardExpirationDateCardFirstNameCardIssuerCodeCardLastNameCardTokenNumberCashReceiptIdCheckNumberInstrumentAssignmentIdMaskedCardNumberOriginalSystemPaymentReferencePaymentDatePaymentMethodPaymentMethodCodePaymentModePaymentModeCodePaymentServerOrderNumberPaymentSetIdPaymentTransactionIdPaymentTypePaymentTypeCodePrepaidAmountTransactionExtensionIdUniquePaymentReferenceVoiceAuthorizationCodepriceAdjustmentsGET Price Adjustments · 7 fieldsAdjustmentNameAdjustmentTypeAdjustmentTypeCodeAmountInvoicedFlagOrigSystemAdjustmentReferencePriceAdjustmentIdpriceValidationsGET Price Validations · 26 fieldsChargeDefinitionChargeDefinitionCodeChargeIdConstrainingValueConstrainingValueTypeCodeConstrainingValueTypeNameExplanationExplanationMessageNameHeaderCurrencyCodeHeaderCurrencyConstrainingAmountHeaderCurrencyNameManualPriceAdjustmentIdPricePeriodicityPricePeriodicityCodePriceValidationIdRollupFlagValidationComponentValidationComponentCodeValidationComponentEntityIdValidationComponentEntityTypeValidationSourceRuleIdValidationSourceTypeValidationSourceTypeCodeValidationStatusViolationTypeCodeViolationTypeNameprojectGET · POST · PATCH Projects · 1 fields · 1 findersDooOrderPrjIdprojectDetailGET · POST · PATCH Project Details · 3 fieldsDooOrderPrjId__FLEX_Context__FLEX_Context_DisplayValuerenewSubscriptionReferenceGET · POST · PATCH Renew Subscription References · 4 fieldsExternalAssetKeyExternalParentAssetKeyExternalRootParentAssetKeySubscriptionProductPuidsalesCreditsGET · POST · PATCH Sales Credits · 7 fields · 1 findersPercentSalesCreditIdSalesCreditTypeSalesCreditTypeIdSalespersonSalespersonIdSourceTransactionSalesCreditIdentifiershipToCustomerGET · POST · PATCH Ship-to Customers · 32 fields · 1 findersAddress1Address2Address3Address4AddressIdCityContactEmailContactFirstNameContactIdContactLastNameContactMiddleNameContactNameContactNameSuffixContactNumberContactTitleCountryCountyPartyEmailPartyIdPartyNamePartyNumberPersonFirstNamePersonLastNamePersonMiddleNamePersonNameSuffixPersonTitlePostalCodePreferredContactPointIdProvinceSiteIdSourceAddressIdStatesubscriptionReferencesGET Subscription Items · 7 fieldsDisplayLineNumberOrderNumberSourceLineNumberSourceOrderNumberSubscriptionFulFillLineIdSubscriptionHeaderIdSubscriptionItemNumbersubscriptionTermGET · POST · PATCH Subscription Terms · 10 fields · 1 findersOrderTermIdSourceOrderTermIdTermAdjustmentPercentTermApplicationMethodTermApplicationMethodCodeTermDurationTermPeriodTermPeriodCodeTermStartDateTermTypeCodesupplyOrderReferenceGET Supply Orders · 2 fieldsDocumentSystemReferenceIdSupplyOrderNumbertransactionItemAttributesGET · POST · PATCH Transaction Item Attributes · 9 fields · 1 findersCharacterAttributeValueDateAttributeValueNumberAttributeValueSourceTransactionLineAttributeIdTimestampAttributeValueTransactionAttributeIdTransactionAttributeMetadataidTransactionAttributeNameTransactionItemAttributeIdnotesGET · POST · PATCH Notes · 6 fieldsDescriptionNoteIdNoteTypeCodeNoteTypeMeaningTextTitlepaymentsGET · POST · PATCH Payments · 31 fields · 1 findersAmountAuthorizationRequestIdAuthorizationStatusAuthorizationStatusCodeAuthorizedAmountAuthorizedInSourceFlagAuthorizedOnCardExpirationDateCardFirstNameCardIssuerCodeCardLastNameCardTokenNumberCashReceiptIdCheckNumberInstrumentAssignmentIdMaskedCardNumberOriginalSystemPaymentReferencePaymentDatePaymentMethodPaymentMethodCodePaymentModePaymentModeCodePaymentServerOrderNumberPaymentSetIdPaymentTransactionIdPaymentTypePaymentTypeCodePrepaidAmountTransactionExtensionIdUniquePaymentReferenceVoiceAuthorizationCodepromotionCodesGET · POST · PATCH Promotion Codes · 5 fields · 2 findersHeaderIdPromocodeIdPromotionCodeStatusStatusCodesalesCreditsGET · POST · PATCH Sales Credits · 7 fields · 1 findersPercentSalesCreditIdSalesCreditTypeSalesCreditTypeIdSalespersonSalespersonIdSourceTransactionSalesCreditIdentifiershipToCustomerGET · POST · PATCH Ship-to Customers · 32 fields · 1 findersAddress1Address2Address3Address4AddressIdCityContactEmailContactFirstNameContactIdContactLastNameContactMiddleNameContactNameContactNameSuffixContactNumberContactTitleCountryCountyPartyEmailPartyIdPartyNamePartyNumberPersonFirstNamePersonLastNamePersonMiddleNamePersonNameSuffixPersonTitlePostalCodePreferredContactPointIdProvinceSiteIdSourceAddressIdStatetotalsGET Totals · 10 fieldsCurrencyCodeCurrencyNameDisplayNameEstimatedFlagOrderTotalIdPrimaryFlagTotalAmountTotalCodeTotalGroupTotalNametotalComponentsGET Total Components · 10 fieldsHeaderCurrencyCodeHeaderCurrencyExtendedAmountHeaderCurrencyNameOrderChargeComponentIdOrderTotalComponentIdOrderTotalIdPriceElementPriceElementCodePriceElementUsagePriceElementUsageCode
Actions 5
POST …/action/applyHold·holdRequestsprocessRequestOfflineAfterPOST …/action/releaseHold·holdRequestsprocessRequestOfflineAfterPOST …/action/splitFulfillmentLine·processRequestOfflineAftersplitFulfillmentLineRequestPOST …/action/updateActualDeliveryDate·updateActualDeliveryDateRequestprocessRequestOfflineAfterintegrationContextCodePOST …/action/updateSchedulingAttribute·updateSchedulingAttributeRequestprocessRequestOfflineAfter
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
/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHuband ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByHeaderIdfor 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:AgreementHeaderId, notagreementheaderid. - 20 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.