1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. Inventory Item Serial Numbers

Get all numbers

get

/fscmRestApi/resources/11.13.18.05/inventoryItemSerialNumbers

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds item serial numbers according to organization, item, and serial number.
      Finder Variables:
      • InventoryItemId; integer; Value that uniquely identifies the inventory item.
      • OrganizationId; integer; Value that uniquely identifies the organization.
      • SerialNumber; string; Serial number that identifies the inventory item.
    • filterByNoOpenCounts: Finds the serial numbers which have no open count sequences.
      Finder Variables:
      • param_CycleCountHeaderId; integer; Finds the serial numbers which have no open count sequences by cycle count header.
      • param_InventoryItemId; integer; Finds the serial numbers which have no open count sequences by item.
      • param_LocatorId; integer; Finds the serial numbers which have no open count sequences by locator.
      • param_LotNumber; string; Finds the serial numbers which have no open count sequences by item for a lot number.
      • param_OrganizationId; integer; Finds the serial numbers which have no open count sequences by organization.
      • param_Subinventory; string; Finds the serial numbers which have no open count sequences by subinventory.
    • findByOrgItemLotAndSerial: Finds serial numbers for an item in an organization. As an option, you can specify the lot and a serial number.
      Finder Variables:
      • bindInventoryItemId; integer; Value that uniquely identifies the inventory item.
      • bindItemNumber; string; Name of the inventory item.
      • bindLotNumber; string; Number that identifies the lot.
      • bindOrganizationCode; string; Abbreviation that identifies the organization.
      • bindSerialNumber; string; Serial number that identifies the inventory item.
    • findRestrictedSerial: Finds the serial numbers that allow specific transactions depending on the material status.
      Finder Variables:
      • param_TransactionTypeId; integer; Value that uniquely identifies the transaction type.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • Allocated; string; Value that indicates whether or not the serial number is allocated. Contains one of the following values: Yes or No. if Yes, then the serial number is allocated. If No, then the serial number is not allocated. The default value is No.
    • InventoryItemId; integer; Value that uniquely identifies the inventory item.
    • ItemDescription; string; Description of the inventory item.
    • ItemNumber; string; Name of the inventory item.
    • ItemPrimaryImageURL; string; URL for the primary image of the inventory item.
    • Locator; string; Name of the locator.
    • LocatorId; integer; Value that uniquely identifies the locator.
    • LotNumber; string; Number that identifies the lot.
    • OrganizationCode; string; Abbreviation that identifies the organization.
    • OrganizationId; integer; Value that uniquely identifies the organization.
    • OrganizationName; string; Name of the organization.
    • OriginalUnitVendorId; integer; Value that uniquely identifies the supplier of the original unit.
    • ReceiptDate; string; Date when the warehouse completed or received the item.
    • Reserved; string; Value that indicates whether or not the serial number is reserved. Contains one of the following values: Yes or No. If Yes, then the serial number is reserved. If No, then the serial number is not reserved. The default value is No.
    • Revision; string; Revision of the item.
    • SerialNumber; string; Serial number that identifies the inventory item.
    • ShippedDate; string; Date when the warehouse shipped the item.
    • StatusCode; string; Abbreviation that identifies the status of the item.
    • StatusId; integer; Value that uniquely identifies the material status.
    • SubinventoryCode; string; Abbreviation that identifies the subinventory.
    • Supplier; string; Name of the supplier.
    • SupplierLot; string; Number that identifies the supplier lot.
    • SupplierSerialNumber; string; Serial number assigned to the item by its supplier.
    • UniqueDeviceIdentifier; string; Value that uniquely identifies the device.
    • Usage; string; Value that identifies the current usage of the serial number. A list of accepted values is defined in the lookup type INV_SERIAL_NUM_STATUS. The default value is Defined but not used.
    • UsageCode; string; Abbreviation that identifies the current usage of the serial number. A list of accepted values is defined in the lookup type INV_SERIAL_NUM_STATUS. The default value is 1.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.

There's no request body for this operation.

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 : inventoryItemSerialNumbers
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : inventoryItemSerialNumbers-item-response
Type: object
Show Source
Nested Schema : Flexfields for Inventory Attributes
Type: array
Title: Flexfields for Inventory Attributes
The Flexfields for Inventory Attributes resource manages the descriptive flexfield information for inventory attributes associated with the serial numbers. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : Flexfields for Serial Number Attributes
Type: array
Title: Flexfields for Serial Number Attributes
The Flexfields for Serial Number Attributes resource manages the descriptive flexfield information for serial number attributes.
Show Source
Nested Schema : Flexfields for Serial Numbers
Type: array
Title: Flexfields for Serial Numbers
The Flexfields for Serial Numbers resource manages the descriptive flexfield information for serial numbers.
Show Source
Nested Schema : inventoryItemSerialNumbers-inventoryAttributesDFF-item-response
Type: object
Show Source
  • Title: Context Segment
    Maximum Length: 40
    Descriptive flexfield context name for inventory attributes. This attribute is associated with a feature that requires opt in.
  • Title: Context Segment
    Descriptive flexfield context display value for inventory attributes. This attribute is associated with a feature that requires opt in.
  • Title: Country of Origin
    Maximum Length: 2
    Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in.
  • Title: Country of Origin
    Name of the country of origin. This attribute is associated with a feature that requires opt in.
  • Value that uniquely identifies the organization. This attribute is associated with a feature that requires opt in.
  • Value that uniquely identifies the item. This attribute is associated with a feature that requires opt in.
  • Links
  • Title: Project
    Value that uniquely identifies the inventory project. This attribute is associated with a feature that requires opt in.
  • Title: Project
    Name of the inventory project. This attribute is associated with a feature that requires opt in.
  • Title: Serial Number
    Maximum Length: 80
    Serial number that identifies the inventory item. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Value that uniquely identifies the inventory task. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Name of the inventory task. This attribute is associated with a feature that requires opt in.
Nested Schema : inventoryItemSerialNumbers-serialAttributeDFF-item-response
Type: object
Show Source
Nested Schema : inventoryItemSerialNumbers-serialStandardDFF-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all item serial numbers from inventory.

Example cURL Command

Use the following cURL command to submit a request on the REST resource. This example gets all serial numbers defined in organization M1 and for inventory item 663997:

curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryItemSrialNumbers?onlyData=true&finder=findByOrgItemLotAndSerial;bindOrganizationCode=M1,bindInventoryItemId=663997"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "items" : [ {
    "OrganizationId" : 207,
    "OrganizationCode" : "M1",
    "OrganizationName" : "Tall Manufacturing\t\t",
    "InventoryItemId" : 663997,
    "ItemNumber" : "VC110",
    "ItemDescription" : "VC-Lot Serial Revision",
    "SerialNumber" : "SerVC100",
    "SubinventoryCode" : "INVRCT02",
    "LocatorId" : 3123,
    "Locator" : "RCV2.1.1",
    "LotNumber" : "S07002",
    "Revision" : "A",
    "StatusId" : 1,
    "StatusCode" : "Active",
    "UsageCode" : "3",
    "Usage" : "Resides in stores",
    "ShippedDate" : null,
    "ReceiptDate" : "2010-01-08",
    "Allocated" : "No",
    "Reserved" : "No"
  } ],
  "count" : 1,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers",
    "name" : "inventoryItemSerialNumbers",
    "kind" : "collection"
  } ]
}
Back to Top