Inbound Shipments
inboundShipments Based on 26C
Change and look up Inbound Shipments, with shipment lines. Actions include cancel ASN and cancel ASN line. No create.
The record key inboundShipmentsUniqID is a generated hash. Take it from the record's links (rel self) in a GET response; never build it yourself.
- Operations
- GET (list)GET (one)PATCH (update)3 actions
- Record key
inboundShipmentsUniqID- Required on create
- no create on this resource
- At a glance
- 59 fields2 finders17 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/inboundShipments?fields=ASNType,BillOfLading,Carrier,Comments,ContainerNumber&limit=25&onlyData=true
{
"items": [
{
"ASNType": "<string, max 25>",
"BillOfLading": "<string, max 25>",
"Carrier": "<string, max 360>",
"Comments": "<string, max 4000>",
"ContainerNumber": "<string, max 30>"
}
],
"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 59
| Attribute | Type | Use |
|---|---|---|
ASNType | text · max 25 | Read-onlySearchable |
BillOfLading | text · max 25 | UpdatableSearchable |
Carrier | text · max 360 | UpdatableSearchable |
Comments | text · max 4000 | UpdatableSearchable |
ContainerNumber | text · max 30 | UpdatableSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
CurrencyCode | text · max 15 | Read-onlySearchable |
ExpectedReceiptDate | date-time | UpdatableSearchable |
FreightAmount | number | Read-onlySearchable |
FreightCarrierId | number | UpdatableSearchable |
FreightTerms | text · max 80 | UpdatableSearchable |
FreightTermsCode | text · max 25 | UpdatableSearchable |
GrossWeight | number | Read-onlySearchable |
GrossWeightUOM | text · max 25 | Read-onlySearchable |
GrossWeightUOMCode | text · max 3 | Read-onlySearchable |
HeaderInterfaceId | number | Read-onlySearchable |
IntegratedSystemCode | text · max 25 | Read-onlySearchable |
InvoiceAmount | number | Read-onlySearchable |
InvoiceDate | date-time | Read-onlySearchable |
InvoiceNumber | text · max 50 | Read-onlySearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
ModeOfTransport | text · max 30 | UpdatableSearchable |
NetWeight | number | UpdatableSearchable |
NetWeightUOM | text · max 25 | UpdatableSearchable |
NetWeightUOMCode | text · max 3 | UpdatableSearchable |
NumberOfContainers | number | UpdatableSearchable |
PackagingCode | text · max 5 | UpdatableSearchable |
PackingSlip | text · max 25 | UpdatableSearchable |
PaymentTerms | text · max 50 | Read-onlySearchable |
PaymentTermsId | number | Read-onlySearchable |
ReceiptNumber | text · max 30 | Read-onlySearchable |
ReceiptSourceCode | text · max 25 | Read-onlySearchable |
ServiceLevel | text · max 30 | UpdatableSearchable |
ShipFromOrganizationCode | text · max 18 | Read-onlySearchable |
ShipFromOrganizationId | number | Read-onlySearchable |
ShipFromOrganizationName | text · max 240 | Read-onlySearchable |
ShipMethodCode | text · max 30 | UpdatableSearchable |
ShipToOrganizationCode | text · max 18 | Read-onlySearchable |
ShipToOrganizationId | number | Read-onlySearchable |
ShipmentHeaderId | number | Read-onlySearchable |
ShipmentNumber | text · max 30 | Read-onlySearchable |
ShippedDate | date-time | UpdatableSearchable |
ShippingMethod | text · max 255 | UpdatableSearchable |
SpecialHandlingCode | text · max 3 | UpdatableSearchable |
SupplierName | text · max 360 | Read-onlySearchable |
SupplierNumber | text · max 30 | Read-onlySearchable |
SupplierShipmentNumber | text · max 30 | UpdatableSearchable |
SupplierSiteCode | text · max 240 | Read-onlySearchable |
TarWeight | number | UpdatableSearchable |
TarWeightUOM | text · max 25 | UpdatableSearchable |
TarWeightUOMCode | text · max 3 | UpdatableSearchable |
TaxAmount | number | Read-onlySearchable |
UpdateCancelShipmentAllowed | text · max 1 | Read-only |
VendorId | number | Read-onlySearchable |
VendorSiteId | number | Read-onlySearchable |
WaybillAirbillNumber | text · max 30 | UpdatableSearchable |
Names, types, labels and flags from Oracle's REST specification (26C). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 2
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findByOrgDateSupplierShipment·bindExpectedReceiptDatebindOrganizationCodebindOrganizationIdbindShipmentHeaderIdbindShipmentNumberbindSupplierbindVendorIdfindByOrgOrderSupplierShipment·bindOrganizationCodebindOrganizationIdbindPOHeaderIdbindPONumberbindShipmentHeaderIdbindShipmentNumberbindSupplierbindTONumberbindTransferOrderHeaderIdbindVendorId
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 17
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/inboundShipments/{inboundShipmentsUniqID}/child/<name>. Add them to a GET with expand.
headerAttachmentsGET · POST · DELETE Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameshipmentHeaderDFFsGET · PATCH Flexfields for Shipment Headers · 3 fieldsShipmentHeaderId__FLEX_Context__FLEX_Context_DisplayValueshipmentLinesGET · PATCH Shipment Lines · 94 fieldsASNLPNIdBackToBackOrderBarCodeLabelCommentsConsignmentLineContainerNumberCountryOfOriginCountryOfOriginCodeCreatedByCreationDateDestinationTypeDestinationTypeCodeEwayBillDateEwayBillNumberFOBCodeFreeOnBoardNameFromOrganizationCodeFromOrganizationIdHazardClassHazardClassIdIntegrationStatusInterfaceTransactionIdInventoryShipmentTransactionIdItemControlItemDescriptionItemIdItemNumberItemRevisionLastUpdateDateLastUpdateLoginLastUpdatedByLineNumberLocatorLocatorIdLotControlCodeLotsCountManufacturerManufacturerPartNumberMarkForCancelFlagMarkForCloseFlagMultiplePartsExistOrganizationCodeOrganizationIdOriginalTOInvShipTransactionIdPOHeaderIdPOLineIdPOLineLocationIdPOLineNumberPONumberPOScheduleNumberPackingSlipPrimaryQuantityPrimaryUOMCodePrimaryUnitOfMeasureQuantityAcceptedQuantityReceivedQuantityRejectedQuantityReturnedQuantityShippedReasonReasonIdRoutingRoutingHeaderIdSecondaryQuantityReceivedSecondaryQuantityShippedSecondaryUOMSecondaryUOMCodeSerialNumberControlCodeSerialsCountShipmentHeaderIdShipmentLineIdShipmentLineStatusShipmentLineStatusCodeSourceDocumentCodeSourcePackingUnitStructureInstanceNumberSubinventorySubinventoryIdSubinventoryNameSupplierItemNumberTaxInvoiceDateTaxInvoiceNumberTransferCostTransferOrderHeaderIdTransferOrderLineIdTransferOrderLineNumberTransferOrderNumberTransferToCostingStatusTransportationCostTruckNumberUNNumberUNNumberIdUOMCodeUnitOfMeasureattachmentsGET · POST · DELETE Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameinventoryStripingDFFGET Flexfields for Inventory Striping Attributes · 9 fieldsShipmentLineId__FLEX_Context__FLEX_Context_DisplayValuecountryOfOriginCodecountryOfOriginCode_DisplayprojectIdprojectId_DisplaytaskIdtaskId_DisplaylotsGET Lots · 23 fieldsCreatedByCreationDateExpirationActionCodeExpirationActionDateGradeCodeHoldDateLastUpdateDateLastUpdateLoginLastUpdatedByLotExpirationDateLotNumberMaturityDateOriginationDateOriginationTypeParentLotNumberQuantityRetestDateSecondaryQuantitySecondaryUOMCodeSerialTransactionIdShipmentLineIdTransactionIdUOMCodelotAttributeDFFGET Flexfields for Lot Attributes · 5 fieldsInventoryItemIdLotNumberOrganizationId__FLEX_Context__FLEX_Context_DisplayValuelotSerialsGET Serials for Lots · 9 fieldsCreatedByCreationDateCurrentStatusLastUpdateDateLastUpdateLoginLastUpdatedBySerialNumberSerialNumberCorrectedFlagSupplierSerialNumberserialAttributeDFFGET Flexfields for Serial Number Attributes · 5 fieldsCurrentOrganizationIdInventoryItemIdSerialNumber__FLEX_Context__FLEX_Context_DisplayValueserialStandardDFFGET Flexfields for Serial Numbers · 5 fieldsCurrentOrganizationIdInventoryItemIdSerialNumber__FLEX_Context__FLEX_Context_DisplayValuelotStandardDFFGET Flexfields for Lots · 5 fieldsInventoryItemIdLotNumberOrganizationId__FLEX_Context__FLEX_Context_DisplayValuemanufacturerPartsGET Manufacturer Parts · 2 fieldsManufacturerNameManufacturerPartNumberpackingUnitsGET Packing Units · 10 fieldsCreatedByCreationDateLPNIdLastUpdateDateLastUpdateLoginLastUpdatedByPackingUnitParentLPNIdParentPackingUnitRootLPNIdserialsGET Serials · 11 fieldsCreatedByCreationDateCurrentStatusLastUpdateDateLastUpdateLoginLastUpdatedBySerialNumberSerialNumberCorrectedFlagShipmentLineIdSupplierSerialNumberTransactionIdserialAttributeDFFGET Flexfields for Serial Number Attributes · 5 fieldsCurrentOrganizationIdInventoryItemIdSerialNumber__FLEX_Context__FLEX_Context_DisplayValueserialStandardDFFGET Flexfields for Serial Numbers · 5 fieldsCurrentOrganizationIdInventoryItemIdSerialNumber__FLEX_Context__FLEX_Context_DisplayValueshipmentLineDFFsGET · PATCH Flexfields for Shipment Lines · 3 fieldsShipmentLineId__FLEX_Context__FLEX_Context_DisplayValue
Actions 3
POST …/action/cancelASN·shipmentHeaderIdPOST …/action/cancelASNLine·shipmentLineIdPOST …/action/closeASNLine·shipmentLineId
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/inboundShipmentsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByOrgDateSupplierShipmentfor 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:BillOfLading, notbilloflading. - 34 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
onlyData=trueremoveslinks, and this resource's key only comes fromlinks. Leave it off when you need the key.- 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.