Sales Orders for Order Hub Requests
salesOrdersForOrderHubRequests Based on 26C
Create, change, delete and look up Sales Orders for Order Hub Requests, with additional information, bill to customer and lines.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE
- Record key
OrderKey- Required on create
- none marked
- At a glance
- 68 fields1 finders30 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHubRequests?fields=AgreementHeaderId,AgreementNumber,BatchName,BillingSetFlag,BuyingPartyContactEmail&limit=25&onlyData=true
{
"items": [
{
"AgreementHeaderId": 0,
"AgreementNumber": "<string, max 150>",
"BatchName": "<string, max 50>",
"BillingSetFlag": false,
"BuyingPartyContactEmail": "<string, max 320>"
}
],
"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 68
| Attribute | Type | Use |
|---|---|---|
AgreementHeaderId | number | Optional on createUpdatableSearchable |
AgreementNumber | text · max 150 | Optional on createUpdatableSearchable |
BatchName | text · max 50 | Optional on createUpdatableSearchable |
BillingSetFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
BuyingPartyContactEmail | text · max 320 | Optional on createUpdatableSearchable |
BuyingPartyContactFirstName | text · max 150 | Optional on createUpdatableSearchable |
BuyingPartyContactId | number | Optional on createUpdatableSearchable |
BuyingPartyContactLastName | text · max 150 | Optional on createUpdatableSearchable |
BuyingPartyContactMiddleName | text · max 60 | Optional on createUpdatableSearchable |
BuyingPartyContactName | text · max 360 | Optional on createUpdatableSearchable |
BuyingPartyContactNameSuffix | text · max 30 | Optional on createUpdatableSearchable |
BuyingPartyContactNumber | text · max 30 | Optional on createUpdatableSearchable |
BuyingPartyContactOrigSystemReference | text · max 255 | Optional on createUpdatableSearchable |
BuyingPartyContactTitle | text · max 60 | Optional on createUpdatableSearchable |
BuyingPartyId | number | Optional on createUpdatableSearchable |
BuyingPartyName | text · max 360 | Optional on createUpdatableSearchable |
BuyingPartyNumber | text · max 30 | Optional on createUpdatableSearchable |
BuyingPartyOrgEmail | text · max 320 | Optional on createUpdatableSearchable |
BuyingPartyOrigSystemReference | text · max 255 | Optional on createUpdatableSearchable |
BuyingPartyPersonEmail | text · max 320 | Optional on createUpdatableSearchable |
BuyingPartyPersonFirstName | text · max 150 | Optional on createUpdatableSearchable |
BuyingPartyPersonLastName | text · max 150 | Optional on createUpdatableSearchable |
BuyingPartyPersonMiddleName | text · max 60 | Optional on createUpdatableSearchable |
BuyingPartyPersonNameSuffix | text · max 30 | Optional on createUpdatableSearchable |
BuyingPartyPersonTitle | text · max 60 | Optional on createUpdatableSearchable |
BuyingPartyType | text · max 30 | Optional on createUpdatableSearchable |
CancelReason | text · max 1000 | Optional on createUpdatableSearchable |
CancelReasonCode | text · max 1000 | Optional on createUpdatableSearchable |
Comments | text · max 2000 | Optional on createUpdatableSearchable |
CurrencyConversionDate | date-time | Optional on createUpdatableSearchable |
CurrencyConversionRate | number | Optional on createUpdatableSearchable |
CurrencyConversionType | text · max 1000 | Optional on createUpdatableSearchable |
CustomerPONumber | text · max 50 | Optional on createUpdatableSearchable |
FreezePriceFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
FreezeShippingChargeFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
FreezeTaxFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
InterfaceStatusCode | text · max 30 | Optional on createUpdatableSearchable |
OperationMode | text · max 30 | Optional on createUpdatableSearchable |
OrderKey | text · max 255 | Optional on createSearchable |
OrderRepresentativeUsername | text · max 100 | Optional on createUpdatableSearchable |
OrderRequestId | number | Optional on createSearchable |
OrigSystemDocumentReference | text · max 50 | Optional on createUpdatableSearchable |
PartialShipAllowedFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
PreCreditCheckedFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
PreferredSoldContactPointOrigSystemReference | text · max 240 | Optional on createUpdatableSearchable |
PreferredSoldToContactPointId | number | Optional on createUpdatableSearchable |
PricedOn | date-time | Optional on createUpdatableSearchable |
PricingDate | date-time | Optional on createUpdatableSearchable |
RequestCancelDate | date-time | Optional on createUpdatableSearchable |
RequestingBusinessUnitId | number | Optional on createUpdatableSearchable |
RequestingBusinessUnitName | text · max 240 | Optional on createUpdatableSearchable |
RequestingLegalUnit | text · max 240 | Optional on createUpdatableSearchable |
RequestingLegalUnitId | number | Optional on createUpdatableSearchable |
RevisionSourceSystem | text · max 30 | Optional on createUpdatableSearchable |
SalesChannel | text · max 80 | Optional on createUpdatableSearchable |
SalesChannelCode | text · max 30 | Optional on createUpdatableSearchable |
Salesperson | text · max 360 | Optional on createUpdatableSearchable |
SalespersonId | number | Optional on createUpdatableSearchable |
SourceTransactionId | text · max 50 | Optional on createSearchable |
SourceTransactionNumber | text · max 50 | Optional on createUpdatableSearchable |
SourceTransactionRevisionNumber | number | Optional on createUpdatableSearchable |
SourceTransactionSystem | text · max 30 | Optional on createSearchable |
TransactionDocumentTypeCode | text · max 50 | Optional on createUpdatableSearchable |
TransactionOn | date-time | Optional on createUpdatableSearchable |
TransactionTypeCode | text · max 30 | Optional on createUpdatableSearchable |
TransactionalCurrencyCode | text · max 1000 | Optional on createUpdatableSearchable |
TransactionalCurrencyName | text · max 1000 | Optional on createUpdatableSearchable |
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 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findByOrderKey·OrderKey
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 30
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHubRequests/{OrderKey}/child/<name>. Add them to a GET with expand.
additionalInformationGET · POST · PATCH · DELETE Additional Details · 41 fields · 1 findersAttributeChar1AttributeChar10AttributeChar11AttributeChar12AttributeChar13AttributeChar14AttributeChar15AttributeChar16AttributeChar17AttributeChar18AttributeChar19AttributeChar2AttributeChar20AttributeChar3AttributeChar4AttributeChar5AttributeChar6AttributeChar7AttributeChar8AttributeChar9AttributeDate1AttributeDate2AttributeDate3AttributeDate4AttributeDate5AttributeNumber1AttributeNumber10AttributeNumber2AttributeNumber3AttributeNumber4AttributeNumber5AttributeNumber6AttributeNumber7AttributeNumber8AttributeNumber9AttributeTimestamp1AttributeTimestamp2AttributeTimestamp3AttributeTimestamp4AttributeTimestamp5ContextCodebillToCustomerGET · POST · PATCH · DELETE Bill-to Customers · 40 fields · 1 findersAccountNumberAddress1Address2Address3Address4AddressOrigSystemReferenceAddressUseTypeCityContactFirstNameContactIdContactLastNameContactMiddleNameContactNameContactNameSuffixContactNumberContactOrigSystemReferenceContactTitleCountryCountyCustomerAccountIdPartyContactEmailPartyNamePartyOrganizationEmailPartyPersonEmailPartyTypePersonFirstNamePersonLastNamePersonMiddleNamePersonNameSuffixPersonTitlePostalCodePreferredContactPointIdPreferredContactPointOrigSystemReferenceProvinceSiteUseIdSourceTransactionIdSourceTransactionLineIdSourceTransactionScheduleIdSourceTransactionSystemStatelinesGET · POST · PATCH · DELETE Order Lines · 168 fields · 2 findersAccountingRuleAccountingRuleCodeActionTypeActionTypeCodeAgreementHeaderIdAgreementLineIdAgreementLineNumberAgreementNumberAssessableValueAssetGroupNumberAttachToSubscriptionBillingSetNameBusinessUnitIdBusinessUnitNameCancelBackordersFlagCancelReasonCancelReasonCodeCommentsComponentIdPathConfigHeaderIdConfigRevisionNumberConfiguratorPathContractEndDateContractStartDateCoveredCustomerProductDescriptionCoveredCustomerProductIdCoveredCustomerProductNumberCoveredProductDescriptionCoveredProductIdCoveredProductNumberCoveredProductSourceSystemReferenceCreditCheckAuthExpiryDateCreditCheckAuthorizationNumberCustomerPOLineNumberCustomerPONumberCustomerPOScheduleNumberCustomerProductDescriptionCustomerProductIdCustomerProductNumberDefaultTaxationCountryDefaultTaxationCountryShortNameDemandClassDemandClassCodeDemandSourceLineReferenceDocumentSubtypeDocumentSubtypeNameEarliestAcceptableArrivalDateEarliestAcceptableShipDateEndCreditMethodEndCreditMethodCodeEndDateEndReasonEndReasonCodeEnforceSingleShipmentFlagExtendedAmountExternalPriceBookNameFOBPointFOBPointCodeFirstPartyTaxRegistrationFirstPartyTaxRegistrationNumberFreightTermsFreightTermsCodeFulfillLineIdFulfillLineKeyIntendedUseClassificationIdIntendedUseClassificationNameInventoryOrganizationCodeInventoryOrganizationIdInventoryOrganizationNameInventoryTransactionFlagInvoicingRuleInvoicingRuleCodeLatestAcceptableArrivalDateLatestAcceptableShipDateOperationModeOrchestrationProcessDisplayNameOrchestrationProcessIdOrchestrationProcessNameOrderedQuantityOrderedUOMOrderedUOMCodeOrigSystemDocumentLineReferenceOrigSystemDocumentReferenceOriginalProductDescriptionOriginalProductIdOriginalProductNumberPackingInstructionsParentSourceTransactionLineIdPartialShipAllowedFlagPaymentTermsPaymentTermsCodeProductCategoryProductCategoryNameProductDescriptionProductFiscalCategoryProductFiscalCategoryIdProductIdProductNumberProductTypeProductTypeNamePromiseArrivalDatePromiseShipDateQuantityForEachModelRequestCancelDateRequestedArrivalDateRequestedFulfillmentOrganizationCodeRequestedFulfillmentOrganizationIdRequestedFulfillmentOrganizationNameRequestedRatePlanIdRequestedRatePlanNumberRequestedShipDateRequestingBusinessUnitIdRequestingBusinessUnitNameRequiredFulfillmentDateReturnReasonReturnReasonCodeRootParentSourceTransactionLineIdSalespersonSalespersonIdScheduleArrivalDateScheduleShipDateServiceCancelDateServiceDurationServiceDurationPeriodCodeServiceDurationPeriodNameShipSetNameShipmentPriorityShipmentPriorityCodeShippingCarrierShippingCarrierCodeShippingInstructionsShippingModeShippingModeCodeShippingServiceLevelShippingServiceLevelCodeSourceScheduleNumberSourceSystemProductReferenceSourceTransactionLineIdSourceTransactionLineNumberSourceTransactionScheduleIdSubinventorySubinventoryCodeSubscriptionProfileIdSubscriptionProfileNameSubstitutionAllowedFlagSubstitutionReasonSubstitutionReasonCodeTaxClassificationTaxClassificationCodeTaxExemptCodeTaxExemptReasonTaxExemptReasonCodeTaxExemptionCertificateNumberThirdPartyTaxRegistrationThirdPartyTaxRegistrationNumberTotalContractAmountTotalContractQuantityTransactionBusinessCategoryTransactionBusinessCategoryNameTransactionCategoryCodeTransactionLineTypeTransactionLineTypeCodeUnitListPriceUnitQuantityUnitSellingPriceUserDefinedFiscClassNameUserDefinedFiscalClassValidConfigurationFlagadditionalInformationGET · POST · PATCH · DELETE Additional Details · 41 fields · 1 findersAttributeChar1AttributeChar10AttributeChar11AttributeChar12AttributeChar13AttributeChar14AttributeChar15AttributeChar16AttributeChar17AttributeChar18AttributeChar19AttributeChar2AttributeChar20AttributeChar3AttributeChar4AttributeChar5AttributeChar6AttributeChar7AttributeChar8AttributeChar9AttributeDate1AttributeDate2AttributeDate3AttributeDate4AttributeDate5AttributeNumber1AttributeNumber10AttributeNumber2AttributeNumber3AttributeNumber4AttributeNumber5AttributeNumber6AttributeNumber7AttributeNumber8AttributeNumber9AttributeTimestamp1AttributeTimestamp2AttributeTimestamp3AttributeTimestamp4AttributeTimestamp5ContextCodeamendSubscriptionReferencesGET · POST · PATCH · DELETE Amend Subscription References · 5 fields · 1 findersDocumentReferenceTypeExternalAssetKeyExternalParentAssetKeyExternalRootParentAssetKeySubscriptionProductPuidassociatedProductReferencesGET · POST · PATCH · DELETE Associated Product Items · 5 fields · 1 findersAssociatedProductFulfillLineIdDocumentReferenceTypeSourceLineIdSourceOrderIdSourceOrderSystembillToCustomerGET · POST · PATCH · DELETE Bill-to Customers · 40 fields · 1 findersAccountNumberAddress1Address2Address3Address4AddressOrigSystemReferenceAddressUseTypeCityContactFirstNameContactIdContactLastNameContactMiddleNameContactNameContactNameSuffixContactNumberContactOrigSystemReferenceContactTitleCountryCountyCustomerAccountIdPartyContactEmailPartyNamePartyOrganizationEmailPartyPersonEmailPartyTypePersonFirstNamePersonLastNamePersonMiddleNamePersonNameSuffixPersonTitlePostalCodePreferredContactPointIdPreferredContactPointOrigSystemReferenceProvinceSiteUseIdSourceTransactionIdSourceTransactionLineIdSourceTransactionScheduleIdSourceTransactionSystemStatebillingPlansGET · POST · PATCH · DELETE Billing Plans · 12 fields · 1 findersBillingNumberOfPeriodsBillingPeriodEndDateBillingPeriodNumberBillingPeriodStartDateBillingPlanTypeCodeBillingTransactionDateCancellationEffectiveDateOverridePeriodOverridePeriodAmountOverridePeriodQuantityPeriodicityCodeSourceBillingPlanIdchargesGET · POST · PATCH · DELETE Charges · 30 fields · 1 findersApplyToApplyToCodeAverageUnitSellingPriceBlockAllowanceBlockSizeChargeCurrencyChargeCurrencyCodeChargeDefinitionChargeDefinitionCodeChargeSubTypeChargeSubtypeCodeChargeTypeChargeTypeCodeGSAUnitPricePricePeriodicityPricePeriodicityCodePriceTypePriceTypeCodePricedQuantityPricedQuantityUOMPricedQuantityUOMCodePrimaryFlagRollupFlagSequenceNumberSourceChargeIdTierAppliesToTierAppliesToCodeTransactionalCurrencyCodeTransactionalUOMCodeUsagePriceLockFlagchargeComponentsGET · POST · PATCH · DELETE Charge Components · 22 fields · 1 findersChargeCurrencyChargeCurrencyCodeChargeCurrencyDurationExtendedAmountChargeCurrencyExtendedAmountChargeCurrencyUnitPriceExplanationHeaderCurrencyHeaderCurrencyCodeHeaderCurrencyDurationExtendedAmountHeaderCurrencyExtendedAmountHeaderCurrencyUnitPricePriceElementPriceElementCodePriceElementUsagePriceElementUsageCodeRollupFlagSequenceNumberSourceChargeComponentIdSourceChargeIdSourceManualPriceAdjustmentIdSourceParentChargeComponentIdTransactionalCurrencyCodechargeTiersGET · POST · PATCH · DELETE Charge Tiers · 8 fields · 1 findersAdjustmentAmountApplicationMethodApplicationMethodCodeBlockSizeSourceOrderChargeTierIdTierFromTierSequenceNumberTierTocoveredAssetReferenceGET · POST · PATCH · DELETE Covered Assets · 2 fields · 1 findersCoveredAssetIdCoveredAssetNumbercoveredProductReferencesGET · POST · PATCH · DELETE Covered Items · 9 fields · 1 findersCoveredFulfillLineIdDocumentReferenceTypeSourceLineIdSourceLineNumberSourceOrderIdSourceOrderNumberSourceOrderSystemSourceTransactionLineIdSourceTransactionScheduleIdexternalAssetReferenceGET · POST · PATCH · DELETE External Asset References · 5 fields · 1 findersDocumentReferenceTypeExternalAssetKeyExternalParentAssetKeyExternalRootParentAssetKeySubscriptionProductPuidlotSerialsGET · POST · PATCH · DELETE Lot Serials · 8 fields · 1 findersItemRevisionNumberItemSerialNumberFromItemSerialNumberToLocatorLocatorIdLotNumberQuantitySourceLotSerialIdmanualPriceAdjustmentsGET · POST · PATCH · DELETE Manual Price Adjustments · 21 fields · 1 findersAdjustmentAmountAdjustmentElementBasisAdjustmentElementBasisNameAdjustmentTypeAdjustmentTypeCodeChargeDefinitionChargeDefinitionCodeChargeRollupFlagCommentsEffectiveNumberOfPeriodsEffectivePeriodFromEffectivePeriodUntilEffectivityTypeEffectivityTypeCodePricePeriodicityPricePeriodicityCodeReasonReasonCodeSequenceNumberSourceManualPriceAdjustmentIdValidationStatusCodeoriginalOrderReferenceGET · POST · PATCH · DELETE Original Orders · 9 fields · 1 findersDocumentReferenceTypeOriginalFulfillLineIdOriginalSourceLineIdOriginalSourceLineNumberOriginalSourceOrderIdOriginalSourceOrderNumberOriginalSourceOrderSystemSourceTransactionLineIdSourceTransactionScheduleIdpaymentsGET · POST · PATCH · DELETE Payments · 22 fields · 1 findersAuthorizationRequestIdAuthorizedAmountCardExpirationDateCardFirstNameCardIssuerCodeCardLastNameCardTokenNumberCheckNumberMaskedCardNumberPaymentDatePaymentMethodPaymentMethodCodePaymentModePaymentModeCodePaymentServerOrderNumberPaymentSetIdPaymentTransactionIdPaymentTypePaymentTypeCodePrepaidAmountSourceTransactionPaymentIdVoiceAuthorizationCodeprojectGET · POST · PATCH · DELETE Projects · 40 fields · 1 findersBillableFlagCapitalizableFlagContractIdContractLineIdContractNumberExpenditureItemDateExpenditureOrganizationNameExpenditureTypeExpenditureTypeIdFundingAllocationIdFundingSourceIdFundingSourceNumberOrganizationIdProjectIdProjectNameProjectNumberReservedAttribute10ReservedAttribute2ReservedAttribute3ReservedAttribute4ReservedAttribute5ReservedAttribute6ReservedAttribute7ReservedAttribute8ReservedAttribute9TaskIdTaskNameTaskNumberUserDefAttribute1UserDefAttribute10UserDefAttribute2UserDefAttribute3UserDefAttribute4UserDefAttribute5UserDefAttribute6UserDefAttribute7UserDefAttribute8UserDefAttribute9WorkTypeWorkTypeIdrenewSubscriptionReferenceGET · POST · PATCH · DELETE Renew Subscription References · 4 fields · 1 findersExternalAssetKeyExternalParentAssetKeyExternalRootParentAssetKeySubscriptionProductPuidsalesCreditsGET · POST · PATCH · DELETE Sales Credits · 6 fields · 1 findersPercentSalesCreditTypeSalesCreditTypeCodeSalespersonSalespersonIdSourceTransactionSalesCreditIdshipToCustomerGET · POST · PATCH · DELETE Ship-to Customers · 41 fields · 1 findersAddress1Address2Address3Address4AddressOrigSystemReferenceAddressUseTypeCityContactFirstNameContactIdContactLastNameContactMiddleNameContactNameContactNameSuffixContactNumberContactOrigSystemReferenceContactTitleCountryCountyPartyContactEmailPartyIdPartyNamePartyNumberPartyOrganizationEmailPartyPersonEmailPartyTypePersonFirstNamePersonLastNamePersonMiddleNamePersonNameSuffixPersonTitlePostalCodePreferredContactPointIdPreferredContactPointOrigSystemReferenceProvinceShipToRequestRegionSiteIdSourceTransactionIdSourceTransactionLineIdSourceTransactionScheduleIdSourceTransactionSystemStatesubscriptionTermGET · POST · PATCH · DELETE Subscription Terms · 8 fields · 1 findersSourceOrderTermIdTermAdjustmentPercentTermApplicationMethodTermApplicationMethodCodeTermDurationTermPeriodTermPeriodCodeTermStartDatesupplierGET · POST · PATCH · DELETE Supplier · 15 fields · 1 findersAddressLine1AddressLine2AddressLine3AddressLine4CityCountryCountyPostalCodeProvinceStateSupplierIdSupplierNameSupplierNumberSupplierSiteIdSupplierSiteNametransactionItemAttributesGET · POST · PATCH · DELETE Transaction Item Attributes · 8 fields · 1 findersCharacterAttributeValueDateAttributeValueNumberAttributeValueSourceTransactionLineAttributeIdTimestampAttributeValueTransactionAttributeIdTransactionAttributeNameTransactionItemAttributeIdorderPreferencesGET · POST · PATCH Order Preferences · 3 fieldsAutoProcessFlagCreateCustomerInformationFlagSubmitFlagpaymentsGET · POST · PATCH · DELETE Payments · 22 fields · 1 findersAuthorizationRequestIdAuthorizedAmountCardExpirationDateCardFirstNameCardIssuerCodeCardLastNameCardTokenNumberCheckNumberMaskedCardNumberPaymentDatePaymentMethodPaymentMethodCodePaymentModePaymentModeCodePaymentServerOrderNumberPaymentSetIdPaymentTransactionIdPaymentTypePaymentTypeCodePrepaidAmountSourceTransactionPaymentIdVoiceAuthorizationCodesalesCreditsGET · POST · PATCH · DELETE Sales Credits · 6 fields · 1 findersPercentSalesCreditTypeSalesCreditTypeCodeSalespersonSalespersonIdSourceTransactionSalesCreditIdshipToCustomerGET · POST · PATCH · DELETE Ship-to Customers · 41 fields · 1 findersAddress1Address2Address3Address4AddressOrigSystemReferenceAddressUseTypeCityContactFirstNameContactIdContactLastNameContactMiddleNameContactNameContactNameSuffixContactNumberContactOrigSystemReferenceContactTitleCountryCountyPartyContactEmailPartyIdPartyNamePartyNumberPartyOrganizationEmailPartyPersonEmailPartyTypePersonFirstNamePersonLastNamePersonMiddleNamePersonNameSuffixPersonTitlePostalCodePreferredContactPointIdPreferredContactPointOrigSystemReferenceProvinceShipToRequestRegionSiteIdSourceTransactionIdSourceTransactionLineIdSourceTransactionScheduleIdSourceTransactionSystemStatesupplierGET · POST · PATCH · DELETE Supplier · 15 fields · 1 findersAddressLine1AddressLine2AddressLine3AddressLine4CityCountryCountyPostalCodeProvinceStateSupplierIdSupplierNameSupplierNumberSupplierSiteIdSupplierSiteName
Use in AI Agent Studio
- Point a Business Object or REST tool at
/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHubRequestsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByOrderKeyfor 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. - 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.