Item Batches
itemBatches Based on 26C
Create, change and look up Item Batches. Actions include upload file.
The record key itemBatchesUniqID 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)POST (create)PATCH (update)1 action
- Record key
itemBatchesUniqID- Required on create
BatchNameSpokeSystemId- At a glance
- 61 fields1 finders1 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/itemBatches?fields=AssignedTo,BatchId,BatchName,BatchNumber,BatchStatus&limit=25&onlyData=true
{
"items": [
{
"AssignedTo": "<string, max 100>",
"BatchId": 0,
"BatchName": "<string, max 80>",
"BatchNumber": "<string, max 40>",
"BatchStatus": "<string, max 20>"
}
],
"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 61
| Attribute | Type | Use |
|---|---|---|
AssignedTo | text · max 100 | Optional on createUpdatableSearchable |
BatchId | number | Read-onlySearchable |
BatchName | text · max 80 | Required on createUpdatableSearchable |
BatchNumber | text · max 40 | Read-onlySearchable |
BatchStatus | text · max 20 | Optional on createUpdatableSearchable |
BatchStatusCode | text · max 1 · default A | Optional on createUpdatableSearchable |
BypassDataSecurityFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ChangeOrderAddAllItemsFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ChangeOrderAssociate | text · max 30 | Optional on createUpdatableSearchable |
ChangeOrderAssociateCode | text · max 30 | Optional on createUpdatableSearchable |
ChangeOrderEffectiveDateType | text · max 30 | Optional on createUpdatableSearchable |
ChangeOrderEffectiveDateTypeCode | text · max 30 · default D | Optional on createUpdatableSearchable |
ChangeOrderName | text · max 240 | Optional on createUpdatableSearchable |
ChangeOrderNumber | text · max 50 | Optional on createUpdatableSearchable |
ChangeOrderOption | text · max 30 | Optional on createUpdatableSearchable |
ChangeOrderOptionCode | text · max 1 | Optional on createUpdatableSearchable |
ChangeOrderSplitAutomaticallyFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
ChangeOrderType | text · max 80 | Optional on createUpdatableSearchable |
ChangeOrderTypeCode | text · max 80 | Optional on createUpdatableSearchable |
ConfirmSingleMatchFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ConfirmUnmatchedNewFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDateTime | date-time | Read-onlySearchable |
DefaultOrganizationCode | text · max 18 | Optional on createSearchable |
DefaultOrganizationId | number | Optional on createSearchable |
DeleteProcessedRows | text · max 20 | Optional on createUpdatableSearchable |
DeleteProcessedRowsCode | text · max 6 | Optional on createUpdatableSearchable |
EnableDataQualityMatchingFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ImportCrossReferencesOnlyFlag | yes/no · max 1 | Optional on createSearchable |
ImportSchedule | text · max 80 | Optional on createUpdatableSearchable |
ImportScheduleCode | text · max 1 | Optional on createUpdatableSearchable |
LastImportRequestId | number | Optional on createSearchable |
LastMatchRequestId | number | Optional on createSearchable |
LastUpdateDateTime | date-time | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
NewItemRequestAddAllItemsFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
NewItemRequestAssociate | text · max 30 | Optional on createUpdatableSearchable |
NewItemRequestAssociateCode | text · max 1 | Optional on createUpdatableSearchable |
NewItemRequestEffectiveDateType | text · max 30 | Optional on createUpdatableSearchable |
NewItemRequestEffectiveDateTypeCode | text · max 30 · default D | Optional on createUpdatableSearchable |
NewItemRequestName | text · max 240 | Optional on createUpdatableSearchable |
NewItemRequestNumber | text · max 50 | Optional on createUpdatableSearchable |
NewItemRequestOption | text · max 30 | Optional on createUpdatableSearchable |
NewItemRequestOptionCode | text · max 1 | Optional on createUpdatableSearchable |
NewItemRequestSplitAutomaticallyFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
PackUpdate | text · max 30 | Optional on createUpdatableSearchable |
PackUpdateCode | text · max 30 | Optional on createUpdatableSearchable |
ProcessItems | text · max 20 | Optional on createUpdatableSearchable |
ProcessItemsCode | text · max 1 | Optional on createUpdatableSearchable |
ScheduleDateTime | date-time | Optional on createUpdatable |
SpokeSystemCode | text · max 80 | Optional on createSearchable |
SpokeSystemId | number | Required on createSearchable |
SpokeSystemName | text · max 80 | Optional on createSearchable |
StructureEffectivityControl | text · max 20 | Optional on createUpdatableSearchable |
StructureEffectivityControlCode | number · default 1 | Optional on createUpdatableSearchable |
StructureEffectivityDateTime | date-time | Optional on createUpdatableSearchable |
StructureName | text · max 80 | Optional on createUpdatableSearchable |
StructureNameCode | text · max 80 | Optional on createUpdatableSearchable |
StructureUpdate | text · max 30 | Optional on createUpdatableSearchable |
StructureUpdateCode | text · max 30 | Optional on createUpdatableSearchable |
Type | text · max 1 · default E | Optional on createSearchable |
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.
BatchIdFinder·BatchId
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 1
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/itemBatches/{itemBatchesUniqID}/child/<name>. Add them to a GET with expand.
itemBatchTranslationsGET · POST · PATCH Item Batch Translations · 8 fieldsBatchIdBatchNameCreatedByCreationDateTimeLanguageLastUpdateDateTimeLastUpdatedBySourceLanguage
Actions 1
POST …/action/uploadFile·errorResponseTypedataFilePathbatchIdimportMapNamebatchNumber
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/itemBatchesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
BatchIdFinderfor 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:AssignedTo, notassignedto. - 6 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. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.