Update one reservation
patch
/fscmRestApi/resources/11.13.18.05/inventoryReservations/{ReservationId}
Request
Path Parameters
-
ReservationId(required): integer(int64)
Value that uniquely identifies the reservation.
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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
- application/json
Root Schema : schema
Type:
Show Source
object
-
Locator: string
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.
-
LocatorId: integer
(int64)
Title:
Locator
Value that uniquely identifies the locator for the reservation. -
LotNumber: string
Title:
Lot
Maximum Length:80
Number that identifies an item or group of items. Applies when the warehouse places the item under lot control. -
PrimaryReservationQuantity: number
Title:
Reserved Quantity
Reserved quantity expressed in the primary unit of measure of the item. -
RequirementDate: string
(date)
Date when the customer requires the item.
-
ReservationQuantity: number
Title:
Reserved Quantity
Reservation quantity expressed in the primary unit of measure. -
ReservationUnitOfMeasure: string
Unit of measure that the user chooses when placing a reservation.
-
ReservationUOMCode: string
Title:
Reservation UOM
Maximum Length:3
Abbreviation that identifies the unit of measure that the user chooses when placing the reservation. -
Revision: string
Maximum Length:
18
Revision of the item. Applies when the warehouse places the item under revision control. -
SecondaryReservationQuantity: number
Title:
Secondary Reserved Quantity
Reservation quantity expressed in the secondary unit of measure. -
serials: array
Serials
Title:
Serials
The Serials resource manages serial numbers for reservations that reserve the on-hand supply. You can use it to create, read, update, or delete serials for a reservation. -
ShipToPartyId: integer
(int64)
Title:
Customer
Value that uniquely identifies the party that receives the item. -
SubinventoryCode: string
Maximum Length:
10
Name of the subinventory that the warehouse uses to make the reservation. -
SubinventoryId: integer
Value that uniquely identifies the subinventory that the warehouse uses to reserve the item.
-
SupplyProjectId: integer
Value that uniquely identifies the project for the supply document.
-
SupplyProjectNumber: string
Number that identifies the project for the supply document.
-
SupplySourceHeaderId: integer
(int64)
Value that uniquely identifies the supply document.
-
SupplySourceHeaderNumber: string
Document that specifies supply details for the item.
-
SupplySourceLineId: integer
(int64)
Value that uniquely identifies the line in the supply document.
-
SupplySourceLineNumber: string
Line number in the supply document.
-
SupplySourceType: string
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.
-
SupplySourceTypeId: integer
(int64)
Value that uniquely identifies the type of the supply document.
-
SupplyTaskId: integer
Value that uniquely identifies the task corresponding to a project for the supply document.
-
SupplyTaskNumber: string
Number that identifies the task corresponding to a project for the supply document.
Nested Schema : Serials
Type:
array
Title:
Serials
The Serials resource manages serial numbers for reservations that reserve the on-hand supply. You can use it to create, read, update, or delete serials for a reservation.
Show Source
Nested Schema : inventoryReservations-serials-item-patch-request
Type:
Show Source
object
-
SerialNumber: string
Maximum Length:
80
Serial number that identifies the item that this reservation uses. Applies when the warehouse places the item under serial control.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : inventoryReservations-item-response
Type:
Show Source
object
-
DemandProjectId: integer
Value that uniquely identifies the project for the demand document.
-
DemandProjectNumber: string
Number that identifies the project for the demand document.
-
DemandSourceHeaderId: integer
(int64)
Value that uniquely identifies the demand document.
-
DemandSourceHeaderNumber: string
Document that specifies demand details for the item that the warehouse will reserve in inventory.
-
DemandSourceLineId: integer
(int64)
Value that uniquely identifies the demand line.
-
DemandSourceLineNumber: string
Value that uniquely identifies the line number in the demand document.
-
DemandSourceName: string
Title:
Demand Document Name
Maximum Length:30
Name of the source that requests the demand. -
DemandSourceType: string
Type of document that requests the inventory reservation. A list of accepted values is defined in the lookup type INV_RESERVATION_SOURCE_TYPES. Values include User Defined, Transfer Order Return, Sales Order, Shipment Request, Account, Movement Request, Account Alias, Transfer order, or Cycle Count.
-
DemandSourceTypeId: integer
(int64)
Value that uniquely identifies the type of document that requests the inventory reservation.
-
DemandTaskId: integer
Value that uniquely identifies the task corresponding to a project for the demand document.
-
DemandTaskNumber: string
Number that identifies the task corresponding to a project for the demand document.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the item in inventory that the warehouse reserves to fulfill the item.
-
ItemNumber: string
Number that identifies the inventory item.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Locator: string
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.
-
LocatorId: integer
(int64)
Title:
Locator
Value that uniquely identifies the locator for the reservation. -
LotNumber: string
Title:
Lot
Maximum Length:80
Number that identifies an item or group of items. Applies when the warehouse places the item under lot control. -
OperationSequenceNumber: string
Sequence number of a specific operation as defined in a work order.
-
OrderInterfaceStatus: string
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then the sales order or the transfer order demand is interfaced to inventory or shipping. If N, then the sales order or the transfer order demand is awaiting to be interfaced to inventory or shipping. This attribute does not have a default value. This attribute is associated with a feature that requires opt in. -
OrganizationCode: string
Abbreviation that identifies the warehouse organization that reserves inventory to fulfill the item.
-
OrganizationId: integer
(int64)
Value that uniquely identifies the warehouse organization that reserves inventory to fulfill the item.
-
PrimaryReservationQuantity: number
Title:
Reserved Quantity
Reserved quantity expressed in the primary unit of measure of the item. -
PrimaryUnitOfMeasure: string
Primary unit of measure of the item.
-
PrimaryUOMCode: string
Maximum Length:
3
Abbreviation that identifies the primary unit of measure. -
RequirementDate: string
(date)
Date when the customer requires the item.
-
ReservationId: integer
(int64)
Value that uniquely identifies the reservation.
-
ReservationQuantity: number
Title:
Reserved Quantity
Reservation quantity expressed in the primary unit of measure. -
ReservationUnitOfMeasure: string
Unit of measure that the user chooses when placing a reservation.
-
ReservationUOMCode: string
Title:
Reservation UOM
Maximum Length:3
Abbreviation that identifies the unit of measure that the user chooses when placing the reservation. -
Revision: string
Maximum Length:
18
Revision of the item. Applies when the warehouse places the item under revision control. -
SecondaryReservationQuantity: number
Title:
Secondary Reserved Quantity
Reservation quantity expressed in the secondary unit of measure. -
SecondaryUnitOfMeasure: string
Secondary unit of measure of the item.
-
SecondaryUOMCode: string
Title:
Secondary UOM
Maximum Length:3
Abbreviation that identifies the secondary unit of measure. -
serials: array
Serials
Title:
Serials
The Serials resource manages serial numbers for reservations that reserve the on-hand supply. You can use it to create, read, update, or delete serials for a reservation. -
ShipToCustomer: string
Read Only:
true
Customer who receives the item. -
ShipToPartyId: integer
(int64)
Title:
Customer
Value that uniquely identifies the party that receives the item. -
SourceFulfillmentLineId: integer
(int64)
Value that order orchestration uses to uniquely identify the reservation.
-
SourceFulfillmentLineNumber: string
Number that identifies a line corresponding to a source fulfillment line.
-
SubinventoryCode: string
Maximum Length:
10
Name of the subinventory that the warehouse uses to make the reservation. -
SubinventoryId: integer
Value that uniquely identifies the subinventory that the warehouse uses to reserve the item.
-
SupplyProjectId: integer
Value that uniquely identifies the project for the supply document.
-
SupplyProjectNumber: string
Number that identifies the project for the supply document.
-
SupplySourceHeaderId: integer
(int64)
Value that uniquely identifies the supply document.
-
SupplySourceHeaderNumber: string
Document that specifies supply details for the item.
-
SupplySourceLineId: integer
(int64)
Value that uniquely identifies the line in the supply document.
-
SupplySourceLineNumber: string
Line number in the supply document.
-
SupplySourceType: string
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.
-
SupplySourceTypeId: integer
(int64)
Value that uniquely identifies the type of the supply document.
-
SupplyTaskId: integer
Value that uniquely identifies the task corresponding to a project for the supply document.
-
SupplyTaskNumber: string
Number that identifies the task corresponding to a project for the supply document.
-
WorkOrderProductId: integer
Read Only:
true
Value that uniquely identifies the finished item that needs to be manufactured. -
WorkOrderProductNumber: string
Read Only:
true
Number that identifies the finished item that needs to be manufactured.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Serials
Type:
array
Title:
Serials
The Serials resource manages serial numbers for reservations that reserve the on-hand supply. You can use it to create, read, update, or delete serials for a reservation.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : inventoryReservations-serials-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SerialNumber: string
Maximum Length:
80
Serial number that identifies the item that this reservation uses. Applies when the warehouse places the item under serial control.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- serials
-
Parameters:
- ReservationId:
$request.path.ReservationId
The Serials resource manages serial numbers for reservations that reserve the on-hand supply. You can use it to create, read, update, or delete serials for a reservation. - ReservationId:
Examples
This example describes how to update a reservation.
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/inventoryReservations/ReservationId"
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.
{ "SupplySourceType":"On hand", "SupplyProjectId":100000015107659, "SupplyTaskId":100000015107691 }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "ReservationId": 2634085, "OrganizationId": 207, "OrganizationCode": "M1", "InventoryItemId": 663997, "ItemNumber": "VC110", "DemandSourceTypeId": 2, "DemandSourceType": "Sales order", "DemandSourceHeaderId": 502091, "DemandSourceHeaderNumber": "SG-SO-91219-10", "DemandSourceName": null, "DemandSourceLineId": 3774397, "DemandSourceLineNumber": "4", "SourceFulfillmentLineId": 1004, "SupplySourceTypeId": 13, "SupplySourceType": "On hand", "SupplySourceHeaderId": null, "SupplySourceHeaderNumber": null, "SupplySourceLineId": null, "SupplySourceLineNumber": null, "Revision": null, "SubinventoryCode": null, "SubinventoryId": null, "LotNumber": null, "LocatorId": null, "Locator": null, "PrimaryReservationQuantity": 1, "PrimaryUOMCode": "Ea", "PrimaryUnitOfMeasure": "Each", "SecondaryReservationQuantity": null, "SecondaryUOMCode": null, "SecondaryUnitOfMeasure": null, "ReservationQuantity": 1, "ReservationUOMCode": "Ea", "ReservationUnitOfMeasure": "Each", "ShipToCustomer": null, "ShipToPartyId": null, "RequirementDate": "2019-12-09", "SupplyProjectId": 100000015107659, "SupplyTaskId": 100000015107691, "DemandProjectId": 100000015107659, "DemandTaskId": 100000015107691, "DemandProjectNumber": "zBI_Projinv-03", "DemandTaskNumber": "1.1", "SupplyProjectNumber": "zBI_Projinv-03", "SupplyTaskNumber": "1.1", "SourceFulfillmentLineNumber": "4", "links": [ {...} ] }