1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. Inventory Staged Reservations

Update an existing inventory reservation interface record

patch

/fscmRestApi/resources/11.13.18.05/inventoryStagedReservations/{inventoryStagedReservationsUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key--- ReservationInterfaceId and ReservationBatchId ---for the Inventory Staged Reservations resource and used to uniquely identify an instance of Inventory Staged Reservations. The client should not generate the hash key value. Instead, the client should query on the Inventory Staged Reservations collection resource with a filter on the primary key values in order to navigate to a specific instance of Inventory Staged Reservations.

    For example: inventoryStagedReservations?q=ReservationInterfaceId=<value1>;ReservationBatchId=<value2>
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Demand Document Number
    Value that identifies the header number for source of demand.
  • Maximum Length: 150
    Identifies the header number for source of demand.
  • Title: Demand Document Line
    Value that identifies the line number for demand source.
  • Maximum Length: 150
    Identifies the line number for demand source.
  • Title: Demand Document Name
    Maximum Length: 30
    Identifies the user defined demand.
  • Title: Demand Document Type ID
    Value that identifies the type of demand. Valid values are 2, 3, 6, 8,and 13. 2 indicates Sales Order, 3 indicates Account, 6 indicates Account Alias, 8 indicates Transfer Order and 13 indicates User defined.
  • Maximum Length: 80
    Identifies the type of demand. Valid values are Sales Order, Account, Account Alias, Transfer Order, and User defined.
  • Title: Error
    Error code returned by the reservations interface manager.
  • Title: Error Explanation
    Maximum Length: 240
    Indicates the error message code for the record in the error.
  • Maximum Length: 240
    Provides the error explanation code for the record in the error.
  • Value that uniquely identifies the inventory item.
  • Maximum Length: 300
    Identifies the inventory item number.
  • Maximum Length: 255
    Abbreviation that identifies the subinventory that the warehouse uses to reserve inventory for the item. It is typically a physical area in the subinventory, such as a row, aisle, bin, or shelf, that stores the item.
  • Title: Locator
    Value that uniquely identifies the locator for the reservation.
  • Title: Locked
    Maximum Length: 30
    Default Value: 2
    Value that identifies if the record is locked to prevent the record from being picked by another reservation interface process. Valid values are 1 and 2. 1 indicates that the record is locked and 2 indicates that the record is available for a lock to be placed on it. The default value is 2.
  • Title: Lot
    Maximum Length: 80
    Number that identifies an item or group of items. Applies when the warehouse places the item under lot control.
  • Maximum Length: 18
    Organization for which the reservation is created.
  • Value that uniquely identifies the organization for which the reservation is created.
  • Maximum Length: 240
    Identifies organization name in which reservation function is performed
  • Title: Reserved Quantity
    Reserved quantity expressed in the primary unit of measure of the item.
  • Maximum Length: 25
    Primary unit of measure of the item.
  • Maximum Length: 3
    Abbreviation that identifies the primary unit of measure.
  • Maximum Length: 255
    Mode in which interface record has to be processed. It has values : Online,Concurrent,Background. Value that identifies the mode of the processing the inventory attribute transaction request lines. It has values : Online,Concurrent,Background. Valid values include 1, 2, and 3. 1 indicates online, 2 indicates concurrent, and 3 indicates background. 1 indicates that the records are inserted in the Inventory Reservations interface with the transaction mode as 1. This invokes Manage Reservations Interface scheduled process to process the records in the reservation interface. 2 indicates that the records are inserted in the Inventory Reservations interface with transaction mode as 2. This invokes Manage Reservations Interface to process the records in the reservation interface. 3 indicates that the records are inserted in the Inventory Reservations interface with transaction mode as 3. User needs to invoke the Manage Reservations Interface scheduled process manually to process the records in the reservation interface.
  • Value that identifies the process mode to be used to process the interface records. Valid values are 1, 2, and 3. 1 indicates online mode of processing, 2 indicates concurrent mode, and 3 indicates background mode.
  • Title: Due Date
    Indicates the requirement date for the reservation.
  • Title: Reservation Action
    Maximum Length: 30
    Value that identifies the reservation action that needs to be performed. Valis values are 1, 2, 3, and 4. 1 indicates Create, 2 indicates Update, 3 indicates Delete, and 4 indicates Transfer.
  • Title: Reserved Quantity
    Identifies the quantity to be reserved in reservation UOM code.
  • Maximum Length: 25
    Identifies the unit of measure for the reservation record.
  • Title: Reservation UOM
    Maximum Length: 3
    Abbreviation that identifies the unit of measure that the user chooses when placing the reservation.
  • Maximum Length: 18
    Revision of the item. Applies when the warehouse enables the item for revision control.
  • Title: Row Status
    Maximum Length: 30
    Indicates the status of the request. Valid values are 1 and 3. 1 indicates Active, and 3 indicates Error.
  • Title: Secondary Reserved Quantity
    Reservation quantity expressed in the secondary unit of measure.
  • Maximum Length: 25
    Secondary unit of measure of the item.
  • Title: Secondary UOM
    Maximum Length: 3
    Abbreviation that identifies the secondary unit of measure.
  • Value that identifies the source fulfillment line for sales order demand.
  • Maximum Length: 10
    Name of the subinventory that the warehouse uses to make the reservation.
  • Value that uniquely identifies the project for the supply document.
  • Maximum Length: 25
    Number that identifies the project for the supply document.
  • Title: Supply Document Number
    Value that identifies the supply document.
  • Maximum Length: 150
    Identifies the supply document.
  • Title: Supply Document Line
    Value that identifies the line number in the supply document.
  • Maximum Length: 150
    Line number in the supply document.
  • Title: Supply Document Type
    Value that uniquely identifies the type of the supply document.
  • Maximum Length: 80
    Type of the supply document. A list of accepted values is defined in the lookup type INV_RESERVATION_SUPPLY_SRC_TYP. Values include Purchase Order, On Hand, Requisition, Transfer Order Return, Work Order, or Transfer Order.
  • Value that uniquely identifies the task corresponding to a project for the supply document.
  • Maximum Length: 100
    Number that identifies the task corresponding to a project for the supply document.
  • Title: To Demand Document Number
    Value that identifies the header number for destination source of demand to update or transfer the reservation.
  • Maximum Length: 150
    Identifies the header number for destination source of demand to update or transfer the reservation.
  • Title: To Demand Document Line ID
    Value that identifies the line number corresponding to a header number for destination source of demand to update or transfer the reservation.
  • Maximum Length: 150
    Identifies the line number corresponding to a header number for destination source of demand to update or transfer the reservation.
  • Title: To Demand Document Name
    Maximum Length: 30
    Identifies the header number for source of demand to update or transfer the reservation.
  • Title: To Demand Document Type
    Identifies the destination demand source type name to update or transfer the reservation. Valid values are 2, 3, 6, 8,and 13. 2 indicates Sales Order, 3 indicates Account, 6 indicates Account Alias, 8 indicates Transfer Order and 13 indicates User defined.
  • Maximum Length: 80
    Identifies the destination demand source type name to update or transfer the reservation. Valid values are Sales Order, Account, Account Alias, Transfer Order, and User defined.
  • Maximum Length: 255
    Identifies the destination locator to update or transfer the reservation.
  • Title: To Locator
    Value that identifies the destination locator to update or transfer the reservation.
  • Title: To Lot
    Maximum Length: 80
    Identifies the lot number to update or transfer the reservation.
  • Title: To Organization
    Value that identifies the organization name to which the reservation is updated or transferred.
  • Maximum Length: 240
    Identifies the organization name to which the reservation is updated or transferred.
  • Title: To Revision
    Maximum Length: 18
    Identifies the destination revision for a revision controlled reserved item.
  • Title: To Subinventory
    Maximum Length: 10
    Identifies the destination subinventory to update or transfer the reservation.
  • Number that identifis the destination supply project to update or transfer the reservation.
  • Maximum Length: 25
    Name of the destination supply project to update or transfer the reservation.
  • Title: To Supply Document Number
    Value that identifies the header number for a destination supply source to update or transfer the reservation.
  • Maximum Length: 150
    Identifies the header number for a destination supply source to update or transfer the reservation.
  • Title: To Supply Document Line
    Value that identifies the line number corresponding to a header number for a destination supply source to update or transfer the reservation.
  • Maximum Length: 150
    Identifies the line number corresponding to a header number for a destination supply source to update or transfer the reservation.
  • Title: To Supply Document Type
    Value that identifies the destination supply source nameto update or transfer the reservation.
  • Maximum Length: 80
    Identifies the destination supply source name to update or transfer the reservation.
  • Value that identifies the destination task used to update and transfer the reservation.
  • Maximum Length: 100
    Identifies the destination task used to update and transfer the reservation.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : inventoryStagedReservations-item-response
Type: object
Show Source
  • Title: Demand Document Number
    Value that identifies the header number for source of demand.
  • Maximum Length: 150
    Identifies the header number for source of demand.
  • Title: Demand Document Line
    Value that identifies the line number for demand source.
  • Maximum Length: 150
    Identifies the line number for demand source.
  • Title: Demand Document Name
    Maximum Length: 30
    Identifies the user defined demand.
  • Title: Demand Document Type ID
    Value that identifies the type of demand. Valid values are 2, 3, 6, 8,and 13. 2 indicates Sales Order, 3 indicates Account, 6 indicates Account Alias, 8 indicates Transfer Order and 13 indicates User defined.
  • Maximum Length: 80
    Identifies the type of demand. Valid values are Sales Order, Account, Account Alias, Transfer Order, and User defined.
  • Title: Error
    Error code returned by the reservations interface manager.
  • Title: Error Explanation
    Maximum Length: 240
    Indicates the error message code for the record in the error.
  • Maximum Length: 240
    Provides the error explanation code for the record in the error.
  • Value that uniquely identifies the inventory item.
  • Maximum Length: 300
    Identifies the inventory item number.
  • Links
  • Maximum Length: 255
    Abbreviation that identifies the subinventory that the warehouse uses to reserve inventory for the item. It is typically a physical area in the subinventory, such as a row, aisle, bin, or shelf, that stores the item.
  • Title: Locator
    Value that uniquely identifies the locator for the reservation.
  • Title: Locked
    Maximum Length: 30
    Default Value: 2
    Value that identifies if the record is locked to prevent the record from being picked by another reservation interface process. Valid values are 1 and 2. 1 indicates that the record is locked and 2 indicates that the record is available for a lock to be placed on it. The default value is 2.
  • Title: Lot
    Maximum Length: 80
    Number that identifies an item or group of items. Applies when the warehouse places the item under lot control.
  • Maximum Length: 18
    Organization for which the reservation is created.
  • Value that uniquely identifies the organization for which the reservation is created.
  • Maximum Length: 240
    Identifies organization name in which reservation function is performed
  • Title: Reserved Quantity
    Reserved quantity expressed in the primary unit of measure of the item.
  • Maximum Length: 25
    Primary unit of measure of the item.
  • Maximum Length: 3
    Abbreviation that identifies the primary unit of measure.
  • Maximum Length: 255
    Mode in which interface record has to be processed. It has values : Online,Concurrent,Background. Value that identifies the mode of the processing the inventory attribute transaction request lines. It has values : Online,Concurrent,Background. Valid values include 1, 2, and 3. 1 indicates online, 2 indicates concurrent, and 3 indicates background. 1 indicates that the records are inserted in the Inventory Reservations interface with the transaction mode as 1. This invokes Manage Reservations Interface scheduled process to process the records in the reservation interface. 2 indicates that the records are inserted in the Inventory Reservations interface with transaction mode as 2. This invokes Manage Reservations Interface to process the records in the reservation interface. 3 indicates that the records are inserted in the Inventory Reservations interface with transaction mode as 3. User needs to invoke the Manage Reservations Interface scheduled process manually to process the records in the reservation interface.
  • Value that identifies the process mode to be used to process the interface records. Valid values are 1, 2, and 3. 1 indicates online mode of processing, 2 indicates concurrent mode, and 3 indicates background mode.
  • Title: Due Date
    Indicates the requirement date for the reservation.
  • Title: Reservation Action
    Maximum Length: 30
    Value that identifies the reservation action that needs to be performed. Valis values are 1, 2, 3, and 4. 1 indicates Create, 2 indicates Update, 3 indicates Delete, and 4 indicates Transfer.
  • Title: Reservation Batch ID
    Value that identifies a reservation batch.
  • Value that identifies a unique reservation record.
  • Title: Reserved Quantity
    Identifies the quantity to be reserved in reservation UOM code.
  • Maximum Length: 25
    Identifies the unit of measure for the reservation record.
  • Title: Reservation UOM
    Maximum Length: 3
    Abbreviation that identifies the unit of measure that the user chooses when placing the reservation.
  • Maximum Length: 18
    Revision of the item. Applies when the warehouse enables the item for revision control.
  • Title: Row Status
    Maximum Length: 30
    Indicates the status of the request. Valid values are 1 and 3. 1 indicates Active, and 3 indicates Error.
  • Title: Secondary Reserved Quantity
    Reservation quantity expressed in the secondary unit of measure.
  • Maximum Length: 25
    Secondary unit of measure of the item.
  • Title: Secondary UOM
    Maximum Length: 3
    Abbreviation that identifies the secondary unit of measure.
  • Value that identifies the source fulfillment line for sales order demand.
  • Maximum Length: 10
    Name of the subinventory that the warehouse uses to make the reservation.
  • Value that uniquely identifies the project for the supply document.
  • Maximum Length: 25
    Number that identifies the project for the supply document.
  • Title: Supply Document Number
    Value that identifies the supply document.
  • Maximum Length: 150
    Identifies the supply document.
  • Title: Supply Document Line
    Value that identifies the line number in the supply document.
  • Maximum Length: 150
    Line number in the supply document.
  • Title: Supply Document Type
    Value that uniquely identifies the type of the supply document.
  • Maximum Length: 80
    Type of the supply document. A list of accepted values is defined in the lookup type INV_RESERVATION_SUPPLY_SRC_TYP. Values include Purchase Order, On Hand, Requisition, Transfer Order Return, Work Order, or Transfer Order.
  • Value that uniquely identifies the task corresponding to a project for the supply document.
  • Maximum Length: 100
    Number that identifies the task corresponding to a project for the supply document.
  • Title: To Demand Document Number
    Value that identifies the header number for destination source of demand to update or transfer the reservation.
  • Maximum Length: 150
    Identifies the header number for destination source of demand to update or transfer the reservation.
  • Title: To Demand Document Line ID
    Value that identifies the line number corresponding to a header number for destination source of demand to update or transfer the reservation.
  • Maximum Length: 150
    Identifies the line number corresponding to a header number for destination source of demand to update or transfer the reservation.
  • Title: To Demand Document Name
    Maximum Length: 30
    Identifies the header number for source of demand to update or transfer the reservation.
  • Title: To Demand Document Type
    Identifies the destination demand source type name to update or transfer the reservation. Valid values are 2, 3, 6, 8,and 13. 2 indicates Sales Order, 3 indicates Account, 6 indicates Account Alias, 8 indicates Transfer Order and 13 indicates User defined.
  • Maximum Length: 80
    Identifies the destination demand source type name to update or transfer the reservation. Valid values are Sales Order, Account, Account Alias, Transfer Order, and User defined.
  • Maximum Length: 255
    Identifies the destination locator to update or transfer the reservation.
  • Title: To Locator
    Value that identifies the destination locator to update or transfer the reservation.
  • Title: To Lot
    Maximum Length: 80
    Identifies the lot number to update or transfer the reservation.
  • Title: To Organization
    Value that identifies the organization name to which the reservation is updated or transferred.
  • Maximum Length: 240
    Identifies the organization name to which the reservation is updated or transferred.
  • Title: To Revision
    Maximum Length: 18
    Identifies the destination revision for a revision controlled reserved item.
  • Title: To Subinventory
    Maximum Length: 10
    Identifies the destination subinventory to update or transfer the reservation.
  • Number that identifis the destination supply project to update or transfer the reservation.
  • Maximum Length: 25
    Name of the destination supply project to update or transfer the reservation.
  • Title: To Supply Document Number
    Value that identifies the header number for a destination supply source to update or transfer the reservation.
  • Maximum Length: 150
    Identifies the header number for a destination supply source to update or transfer the reservation.
  • Title: To Supply Document Line
    Value that identifies the line number corresponding to a header number for a destination supply source to update or transfer the reservation.
  • Maximum Length: 150
    Identifies the line number corresponding to a header number for a destination supply source to update or transfer the reservation.
  • Title: To Supply Document Type
    Value that identifies the destination supply source nameto update or transfer the reservation.
  • Maximum Length: 80
    Identifies the destination supply source name to update or transfer the reservation.
  • Value that identifies the destination task used to update and transfer the reservation.
  • Maximum Length: 100
    Identifies the destination task used to update and transfer the reservation.
Back to Top

Examples

This example describes how to update an existing inventory reservation interface record.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/inventoryStagedReservations/inventoryStagedReservationsUniqID"
For example:
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052120000000EACED000577080000000000002B68"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates. 

{
    "ReservationQuantity":10
}
       Output Payload :
{
    "ReservationInterfaceId": 21010,
    "ReservationBatchId": 11112,
    "ReservationActionCode": "1",
    "ProcessMode": null,
    "ProcessModeCode": null,
    "RequirementDate": "2022-04-20",
    "ItemNumber": "AS54888",
    "InventoryItemId": null,
    "OrganizationName": "Seattle Manufacturing",
    "OrganizationCode": null,
    "OrganizationId": 207,
    "DemandSourceTypeName": "Sales order",
    "DemandSourceTypeId": null,
    "DemandSourceName": null,
    "DemandSourceHeaderNumber": "HK-SO-TEST",
    "DemandSourceHeaderId": null,
    "DemandSourceLineNumber": "1",
    "DemandSourceLineId": null,
    "SourceFulfillmentLineId": null,
    "ReservationQuantity": 10,
    "ReservationUnitOfMeasure": "Each",
    "ReservationUOMCode": null,
    "PrimaryReservationQuantity": null,
    "PrimaryUnitOfMeasure": null,
    "PrimaryUOMCode": null,
    "SecondaryReservationQuantity": null,
    "SecondaryUnitOfMeasure": null,
    "SecondaryUOMCode": null,
    "SupplySourceTypeName": "On hand",
    "SupplySourceTypeId": null,
    "SupplySourceHeaderNumber": null,
    "SupplySourceHeaderId": null,
    "SupplySourceLineNumber": null,
    "SupplySourceLineId": null,
    "Revision": null,
    "SubinventoryCode": null,
    "Locator": null,
    "LocatorId": null,
    "LotNumber": null,
    "SupplyProjectNumber": null,
    "SupplyProjectId": null,
    "SupplyTaskNumber": null,
    "SupplyTaskId": null,
    "ToOrganizationName": null,
    "ToOrganizationId": null,
    "ToDemandSourceTypeName": null,
    "ToDemandSourceTypeId": null,
    "ToDemandSourceName": null,
    "ToDemandSourceHeaderNumber": null,
    "ToDemandSourceHeaderId": null,
    "ToDemandSourceLineNumber": null,
    "ToDemandSourceLineId": null,
    "ToSupplySourceTypeName": null,
    "ToSupplySourceTypeId": null,
    "ToSupplySourceHeaderNumber": null,
    "ToSupplySourceHeaderId": null,
    "ToSupplySourceLineNumber": null,
    "ToSupplySourceLineId": null,
    "ToRevision": null,
    "ToSubinventoryCode": null,
    "ToLocator": null,
    "ToLocatorId": null,
    "ToLotNumber": null,
    "ToSupplyProjectNumber": null,
    "ToSupplyProjectId": null,
    "ToSupplyTaskNumber": null,
    "ToSupplyTaskId": null,
    "LockCode": "2",
    "RowStatusCode": "1",
    "ErrorCode": null,
    "ErrorExplanationCode": null,
    "ErrorExplanation": null,
    "links": [
        {
            "rel": "self",
            "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052120000000EACED000577080000000000002B68",
            "name": "inventoryStagedReservations",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052120000000EACED000577080000000000002B68",
            "name": "inventoryStagedReservations",
            "kind": "item"
        }
    ]
}
Back to Top