Create details
/fscmRestApi/resources/11.13.18.05/availableQuantityDetails
Request
-
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.
- application/json
object
-
AvailableToReserve: number
Quantity of an item available to reserve.
-
AvailableToTransact: number
Quantity that is available for transactions after the warehouse considers allocations and reservations.
-
InventoryCountryOfOrigin: string
Name of the inventory country of origin. This attribute is associated with a feature that requires opt in.
-
InventoryCountryOfOriginCode: string
Abbreviation that identifies the inventory country of origin. This attribute is associated with a feature that requires opt in.
-
InventoryItemId: integer
Value that uniquely identifies the inventory item.
-
InventoryProject: string
Name of the inventory project. This attribute is associated with a feature that requires opt in.
-
InventoryProjectId: integer
Value that uniquely identifies the inventory project. This attribute is associated with a feature that requires opt in.
-
InventoryTask: string
Name of inventory task. This attribute is associated with a feature that requires opt in.
-
InventoryTaskId: integer
Value that uniquely identifies the inventory task associated with the inventory project. This attribute is associated with a feature that requires opt in.
-
ItemNumber: string
Name of the item.
-
ItemRevision: string
Revision of the item.
-
Locator: string
Description of the stock locators. It is typically a physical area in the subinventory, such as a row, aisle, bin, or shelf, that stores the item.
-
LocatorId: integer
Value that uniquely identifies the stock locator.
-
Lot: string
Number that identifies an item or group of items.
-
OrganizationCode: string
Abbreviation that identifies the inventory organization.
-
OrganizationId: integer
Value that uniquely identifies the inventory organization.
-
OwningEntityId: integer
Value that uniquely identifies the owning party.
-
OwningPartySite: string
Name corresponding to the owning entity identifier.
-
PrimaryUnitOfMeasure: string
Primary unit of measure of the item.
-
QuantityOnhand: number
On-hand quantity for the item.
-
ReceivingTransactionId: integer
Value that uniquely identifies the receiving transaction.
-
ReturnMessageName: string
Message name to use if a failure occurs.
-
ReturnMessageText: string
Message text to use if a failure occurs.
-
ReturnStatus: string
Return status of the resource. Values include SUCCESS or ERROR.
-
SecondaryAvailableToReserve: number
Quantity available to reserve in the secondary unit of measure.
-
SecondaryAvailableToTransact: number
Quantity that is available for transactions in the secondary unit of measure.
-
SecondaryQuantityOnhand: number
On-hand quantity for the item in the secondary unit of measure.
-
SecondaryUnitOfMeasure: string
Secondary unit of measure of the item.
-
Subinventory: string
Name of the subinventory.
-
TreeMode: integer
Parameter that determines the way the available quantity is calculated. Values include 1, 2, 4, and 5. 1 and 2 is for transaction mode. 4 is for transfer to owned mode. 5 is for transfer to consigned mode.
Response
- application/json
Default Response
-
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.
object
-
AvailableToReserve: number
Quantity of an item available to reserve.
-
AvailableToTransact: number
Quantity that is available for transactions after the warehouse considers allocations and reservations.
-
InventoryCountryOfOrigin: string
Name of the inventory country of origin. This attribute is associated with a feature that requires opt in.
-
InventoryCountryOfOriginCode: string
Abbreviation that identifies the inventory country of origin. This attribute is associated with a feature that requires opt in.
-
InventoryItemId: integer
Value that uniquely identifies the inventory item.
-
InventoryProject: string
Name of the inventory project. This attribute is associated with a feature that requires opt in.
-
InventoryProjectId: integer
Value that uniquely identifies the inventory project. This attribute is associated with a feature that requires opt in.
-
InventoryTask: string
Name of inventory task. This attribute is associated with a feature that requires opt in.
-
InventoryTaskId: integer
Value that uniquely identifies the inventory task associated with the inventory project. This attribute is associated with a feature that requires opt in.
-
ItemNumber: string
Name of the item.
-
ItemRevision: string
Revision of the item.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Locator: string
Description of the stock locators. It is typically a physical area in the subinventory, such as a row, aisle, bin, or shelf, that stores the item.
-
LocatorId: integer
Value that uniquely identifies the stock locator.
-
Lot: string
Number that identifies an item or group of items.
-
OrganizationCode: string
Abbreviation that identifies the inventory organization.
-
OrganizationId: integer
Value that uniquely identifies the inventory organization.
-
OwningEntityId: integer
Value that uniquely identifies the owning party.
-
OwningPartySite: string
Name corresponding to the owning entity identifier.
-
PrimaryUnitOfMeasure: string
Primary unit of measure of the item.
-
QuantityOnhand: number
On-hand quantity for the item.
-
ReceivingTransactionId: integer
Value that uniquely identifies the receiving transaction.
-
ReturnMessageName: string
Message name to use if a failure occurs.
-
ReturnMessageText: string
Message text to use if a failure occurs.
-
ReturnStatus: string
Return status of the resource. Values include SUCCESS or ERROR.
-
SecondaryAvailableToReserve: number
Quantity available to reserve in the secondary unit of measure.
-
SecondaryAvailableToTransact: number
Quantity that is available for transactions in the secondary unit of measure.
-
SecondaryQuantityOnhand: number
On-hand quantity for the item in the secondary unit of measure.
-
SecondaryUnitOfMeasure: string
Secondary unit of measure of the item.
-
Subinventory: string
Name of the subinventory.
-
TreeMode: integer
Parameter that determines the way the available quantity is calculated. Values include 1, 2, 4, and 5. 1 and 2 is for transaction mode. 4 is for transfer to owned mode. 5 is for transfer to consigned mode.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to create quantity details.
Example cURL Command
Use the following cURL command to submit a request on the REST resource. This example creates quantity details for inventory item 663913 in organization 207:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/availableQuantityDetails"
Example 1 Request Body
The following example includes the contents of the request body in JSON format:
{ "OrganizationCode":"M1", "ItemNumber":"VC110", "ItemRevision":"A", "InventoryProject":"PJC_CrossCharge_Flow", "InventoryTask":"1.1", "Subinventory":"CSL1", "Lot":"M1-XL003", "InventoryCountryOfOrigin":"India" }
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "OrganizationCode": "M1", "OrganizationId": 207, "ItemNumber": "VC110", "InventoryItemId": 663997, "ItemRevision": "A", "Subinventory": "CSL1", "LocatorId": null, "Lot": "M1-XL003", "OwningEntityId": null, "PrimaryUnitOfMeasure": "Each", "QuantityOnhand": 10, "AvailableToTransact": 10, "SecondaryUnitOfMeasure": null, "SecondaryQuantityOnhand": null, "SecondaryAvailableToTransact": null, "ReturnStatus": "SUCCESS", "ReturnMessageName": null, "ReturnMessageText": null, "InventoryProject": "PJC_CrossCharge_Flow", "InventoryProjectId": 300100071632862, "InventoryTask": "1.1", "InventoryTaskId": 100100039558374, "InventoryCountryOfOrigin": "India", "InventoryCountryOfOriginCode": "IN", "Locator": null, "OwningPartySite": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/availableQuantityDetails/99999", "name": "availableQuantityDetails", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/availableQuantityDetails/99999", "name": "availableQuantityDetails", "kind": "item" } ] }
Example 2 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 creates.
{ "OrganizationId":204, "InventoryItemId":924, "OwningEntityId":300100039215443 }
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{ "OrganizationCode": null, "OrganizationId": 204, "ItemNumber": null, "InventoryItemId": 924, "ItemRevision": null, "Subinventory": null, "LocatorId": null, "Lot": null, "OwningEntityId": 300100039215443, "PrimaryUnitOfMeasure": "Each", "QuantityOnhand": 55583, "AvailableToTransact": 55583, "SecondaryUnitOfMeasure": null, "SecondaryQuantityOnhand": null, "SecondaryAvailableToTransact": null, "ReturnStatus": "SUCCESS", "ReturnMessageName": null, "ReturnMessageText": null, "InventoryProject": null, "InventoryProjectId": null, "InventoryTask": null, "InventoryTaskId": null, "InventoryCountryOfOrigin": null, "InventoryCountryOfOriginCode": null, "Locator": null, "OwningPartySite": "CISuppB00Site02", "links": [ { ... }