Jump to

• Request
• Response
• Examples

Create details

post

/fscmRestApi/resources/11.13.18.05/availableQuantityDetails

Request

Header Parameters

• Metadata-Context: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AvailableToReserve: number
  Quantity of an item available to reserve.
• AvailableToTransact: number
  Quantity that is available for transactions after the warehouse considers allocations and reservations.
• CountryOfOriginEnabledFlag: boolean
  Value that indicates if the on-hand quantity is for an organization enabled for inventory tracking by country of origin.
• DemandSourceHeaderId: integer
  Value that uniquely identifies the demand document querying for availability.
• DemandSourceLineId: integer
  Value that uniquely identifies the demand line querying for availability.
• DemandSourceName: string
  Name of the source demand that's querying for availability.
• DemandSourceTypeId: integer
  Value that uniquely identifies the type of demand document querying for availability.
• 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.
• LPNId: integer
  Value that uniquely identifies a license plate number.
• 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.
• ProjectEnabledFlag: boolean
  Value that indicates if the on-hand quantity is for an organization enabled for inventory tracking by project.
• 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.
• TransferLocator: string
  Name of the destination locator in a subinventory transfer.
• TransferLocatorId: integer
  Value that uniquely identifies the destination locator in a subinventory transfer.
• TransferSubinventoryCode: string
  Subinventory code of the destination subinventory in a subinventory transfer.
• 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.

{
    "type":"object",
    "properties":{
        "SecondaryUnitOfMeasure":{
            "type":"string",
            "description":"Secondary unit of measure of the item.",
            "nullable":true,
            "x-queryable":false
        },
        "CountryOfOriginEnabledFlag":{
            "type":"boolean",
            "description":"Value that indicates if the on-hand quantity is for an organization enabled for inventory tracking by country of origin.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnMessageName":{
            "type":"string",
            "description":"Message name to use if a failure occurs.",
            "nullable":true,
            "x-queryable":false
        },
        "TransferLocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the destination locator in a subinventory transfer.",
            "nullable":true,
            "x-queryable":false
        },
        "DemandSourceName":{
            "type":"string",
            "description":"Name of the source demand that's querying for availability.",
            "nullable":true
        },
        "InventoryTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory task associated with the inventory project. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":false
        },
        "LPNId":{
            "type":"integer",
            "description":"Value that uniquely identifies a license plate number.",
            "nullable":true,
            "x-queryable":false
        },
        "Locator":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "DemandSourceTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the type of demand document querying for availability.",
            "nullable":true
        },
        "ItemNumber":{
            "type":"string",
            "description":"Name of the item.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryAvailableToTransact":{
            "type":"number",
            "description":"Quantity that is available for transactions in the secondary unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryTask":{
            "type":"string",
            "description":"Name of inventory task. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":false
        },
        "DemandSourceHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand document querying for availability.",
            "nullable":true
        },
        "DemandSourceLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand line querying for availability.",
            "nullable":true
        },
        "AvailableToTransact":{
            "type":"number",
            "description":"Quantity that is available for transactions after the warehouse considers allocations and reservations.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization.",
            "nullable":true,
            "x-queryable":false
        },
        "TransferSubinventoryCode":{
            "type":"string",
            "description":"Subinventory code of the destination subinventory in a subinventory transfer.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemRevision":{
            "type":"string",
            "description":"Revision of the item.",
            "nullable":true,
            "x-queryable":false
        },
        "OwningEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the owning party.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryAvailableToReserve":{
            "type":"number",
            "description":"Quantity available to reserve in the secondary unit of measure.",
            "nullable":true
        },
        "InventoryCountryOfOriginCode":{
            "type":"string",
            "description":"Abbreviation that identifies the inventory country of origin. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":false
        },
        "AvailableToReserve":{
            "type":"number",
            "description":"Quantity of an item available to reserve.",
            "nullable":true
        },
        "ProjectEnabledFlag":{
            "type":"boolean",
            "description":"Value that indicates if the on-hand quantity is for an organization enabled for inventory tracking by project.",
            "nullable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "nullable":true,
            "x-queryable":false
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the stock locator.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryQuantityOnhand":{
            "type":"number",
            "description":"On-hand quantity for the item in the secondary unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "TransferLocator":{
            "type":"string",
            "description":"Name of the destination locator in a subinventory transfer.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnMessageText":{
            "type":"string",
            "description":"Message text to use if a failure occurs.",
            "nullable":true,
            "x-queryable":false
        },
        "Lot":{
            "type":"string",
            "description":"Number that identifies an item or group of items.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryUnitOfMeasure":{
            "type":"string",
            "description":"Primary unit of measure of the item.",
            "nullable":true,
            "x-queryable":false
        },
        "ReceivingTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receiving transaction.",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryProject":{
            "type":"string",
            "description":"Name of the inventory project. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":false
        },
        "OwningPartySite":{
            "type":"string",
            "description":"Name corresponding to the owning entity identifier.",
            "nullable":true,
            "x-queryable":false
        },
        "Subinventory":{
            "type":"string",
            "description":"Name of the subinventory.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnStatus":{
            "type":"string",
            "description":"Return status of the resource. Values include SUCCESS or ERROR.",
            "nullable":true,
            "x-queryable":false
        },
        "TreeMode":{
            "type":"integer",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryProjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory project. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryCountryOfOrigin":{
            "type":"string",
            "description":"Name of the inventory country of origin. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":false
        },
        "QuantityOnhand":{
            "type":"number",
            "description":"On-hand quantity for the item.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : availableQuantityDetails-item-response

Type: object

Show Source

• AvailableToReserve: number
  Quantity of an item available to reserve.
• AvailableToTransact: number
  Quantity that is available for transactions after the warehouse considers allocations and reservations.
• CountryOfOriginEnabledFlag: boolean
  Value that indicates if the on-hand quantity is for an organization enabled for inventory tracking by country of origin.
• DemandSourceHeaderId: integer
  Value that uniquely identifies the demand document querying for availability.
• DemandSourceLineId: integer
  Value that uniquely identifies the demand line querying for availability.
• DemandSourceName: string
  Name of the source demand that's querying for availability.
• DemandSourceTypeId: integer
  Value that uniquely identifies the type of demand document querying for availability.
• 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.
• LPNId: integer
  Value that uniquely identifies a license plate number.
• 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.
• ProjectEnabledFlag: boolean
  Value that indicates if the on-hand quantity is for an organization enabled for inventory tracking by project.
• 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.
• TransferLocator: string
  Name of the destination locator in a subinventory transfer.
• TransferLocatorId: integer
  Value that uniquely identifies the destination locator in a subinventory transfer.
• TransferSubinventoryCode: string
  Subinventory code of the destination subinventory in a subinventory transfer.
• 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.

{
    "type":"object",
    "properties":{
        "SecondaryUnitOfMeasure":{
            "type":"string",
            "description":"Secondary unit of measure of the item.",
            "nullable":true,
            "x-queryable":false
        },
        "CountryOfOriginEnabledFlag":{
            "type":"boolean",
            "description":"Value that indicates if the on-hand quantity is for an organization enabled for inventory tracking by country of origin.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnMessageName":{
            "type":"string",
            "description":"Message name to use if a failure occurs.",
            "nullable":true,
            "x-queryable":false
        },
        "TransferLocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the destination locator in a subinventory transfer.",
            "nullable":true,
            "x-queryable":false
        },
        "DemandSourceName":{
            "type":"string",
            "description":"Name of the source demand that's querying for availability.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory task associated with the inventory project. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":false
        },
        "LPNId":{
            "type":"integer",
            "description":"Value that uniquely identifies a license plate number.",
            "nullable":true,
            "x-queryable":false
        },
        "Locator":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "DemandSourceTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the type of demand document querying for availability.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "type":"string",
            "description":"Name of the item.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryAvailableToTransact":{
            "type":"number",
            "description":"Quantity that is available for transactions in the secondary unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryTask":{
            "type":"string",
            "description":"Name of inventory task. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":false
        },
        "DemandSourceHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand document querying for availability.",
            "nullable":true,
            "x-queryable":true
        },
        "DemandSourceLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand line querying for availability.",
            "nullable":true,
            "x-queryable":true
        },
        "AvailableToTransact":{
            "type":"number",
            "description":"Quantity that is available for transactions after the warehouse considers allocations and reservations.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization.",
            "nullable":true,
            "x-queryable":false
        },
        "TransferSubinventoryCode":{
            "type":"string",
            "description":"Subinventory code of the destination subinventory in a subinventory transfer.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemRevision":{
            "type":"string",
            "description":"Revision of the item.",
            "nullable":true,
            "x-queryable":false
        },
        "OwningEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the owning party.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryAvailableToReserve":{
            "type":"number",
            "description":"Quantity available to reserve in the secondary unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryCountryOfOriginCode":{
            "type":"string",
            "description":"Abbreviation that identifies the inventory country of origin. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":false
        },
        "AvailableToReserve":{
            "type":"number",
            "description":"Quantity of an item available to reserve.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectEnabledFlag":{
            "type":"boolean",
            "description":"Value that indicates if the on-hand quantity is for an organization enabled for inventory tracking by project.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "nullable":true,
            "x-queryable":false
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the stock locator.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryQuantityOnhand":{
            "type":"number",
            "description":"On-hand quantity for the item in the secondary unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "TransferLocator":{
            "type":"string",
            "description":"Name of the destination locator in a subinventory transfer.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnMessageText":{
            "type":"string",
            "description":"Message text to use if a failure occurs.",
            "nullable":true,
            "x-queryable":false
        },
        "Lot":{
            "type":"string",
            "description":"Number that identifies an item or group of items.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryUnitOfMeasure":{
            "type":"string",
            "description":"Primary unit of measure of the item.",
            "nullable":true,
            "x-queryable":false
        },
        "ReceivingTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receiving transaction.",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryProject":{
            "type":"string",
            "description":"Name of the inventory project. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":false
        },
        "OwningPartySite":{
            "type":"string",
            "description":"Name corresponding to the owning entity identifier.",
            "nullable":true,
            "x-queryable":false
        },
        "Subinventory":{
            "type":"string",
            "description":"Name of the subinventory.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnStatus":{
            "type":"string",
            "description":"Return status of the resource. Values include SUCCESS or ERROR.",
            "nullable":true,
            "x-queryable":false
        },
        "TreeMode":{
            "type":"integer",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryProjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory project. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryCountryOfOrigin":{
            "type":"string",
            "description":"Name of the inventory country of origin. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":false
        },
        "QuantityOnhand":{
            "type":"number",
            "description":"On-hand quantity for the item.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

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": [
	{
		...
	}
	

Back to Top