1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Inventory Management
  4. List of Values
  5. Lines to Put Away

Get all lines

get

/fscmRestApi/resources/11.13.18.05/linesToPutAway

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: Abbreviation that identifies the ship-to organization for the line to put away.
      Finder Variables:
      • ParentTransactionId; integer; Value that uniquely identifies the parent transaction.
    • findLines: Find received lines that are available to put away according to the bind variables that you provide. You must include the following: 1, bindOrganizationId or bindOrganizationCode; 2, bindDocumentType or bindSourceDocumentCode; 3, bindDocumentNumber.
      Finder Variables:
      • bindASNLineNumber; integer; Line number for the advance shipment notice.
      • bindASNNumber; string; Number that identifies the advanced shipment notice for a shipment from a supplier.
      • bindBackToBack; string; Contains Y or N. Y: use back-to-back shipping. N: reference a transfer order. Note that the order line for the supply source for the reservation references this purchase order.
      • bindConsigned; string; Contains Y or N. Y: the receipt is consigned. N: the receipt is not consigned.
      • bindDocumentDistributionNumber; integer; Distribution number for the document schedule. You can use it only for a purchase order or a transfer order.
      • bindDocumentLineNumber; string; Line number for the document number.
      • bindDocumentNumber; string; Document number that identifies one of the following: a purchase order number for a purchase order, advance shipment notice, or advance shipment billing notice; the number for the return material authorization for a source document code of type RMA; the in-transit shipment number for a source document code of type INVENTORY; or the transfer order number for a source document code of type TRANSFER ORDER.
      • bindDocumentScheduleNumber; string; Schedule number for the document line number.
      • bindDocumentType; string; Document type according to the originating source, such as purchase order or return material authorization. The RCV_SOURCE_DOCUMENT_TYPE lookup defines the values that you can use with this attribute.
      • bindFromDate; string; Start date of the time interval to use when finding the lines to put away.
      • bindItemId; integer; Value that uniquely identifies an item.
      • bindItemNumber; string; Number that identifies the item to put away. An item is any part, material, product, or service that includes attributes that are unique when compared to other items.
      • bindOrganizationCode; string; Value that identifies the ship-to organization code for the received line.
      • bindOrganizationId; integer; Value that uniquely identifies the ship-to organization for the received line.
      • bindPODistributionId; integer; Value that uniquely identifies the purchase order distribution.
      • bindPOHeaderId; integer; Value that uniquely identifies the purchase order header.
      • bindPOLineId; integer; Value that uniquely identifies the purchase order line.
      • bindPOLineLocationId; integer; Value that uniquely identifies the purchase order schedule.
      • bindParentTransactionId; integer; Value that uniquely identifies the parent transaction.
      • bindReceiptAdviceHeaderId; integer; Value that uniquely identifies the receipt advice header.
      • bindReceiptAdviceLineId; integer; Value that uniquely identifies the receipt advice line.
      • bindReceiptNumber; string; Number that acknowledges that the warehouse received a shipment.
      • bindShipmentHeaderId; integer; Value that uniquely identifies the shipment header.
      • bindShipmentLineId; integer; Value that uniquely identifies the shipment line.
      • bindSourceDocumentCode; string; Document type of the shipment. You can use one of the following values with this attribute: PO, RMA, TRANSFER ORDER, or INVENTORY.
      • bindToDate; string; End date of the time interval to use when finding the lines to put away.
      • bindTransferOrderDistId; integer; Value that uniquely identifies the transfer order distribution.
      • bindTransferOrderHeaderId; integer; Value that uniquely identifies the transfer order header. Each transfer order can request to move items from one location to another location.
      • bindTransferOrderLineId; integer; Value that uniquely identifies the transfer order line.
  • 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:
    • ASNLineNumber; integer; Line number of the advanced shipment notice.
    • ASNNumber; string; Number that identifies the advanced shipment notice for the shipment from the supplier.
    • AvailableQuantity; number; Quantity that is available to put away the parent transaction.
    • BackToBack; string; Contains Y or N. Y: use back-to-back shipping. N: reference a transfer order. Note that the order line for the supply source for the reservation references this purchase order. The default value is N.
    • CategoryId; integer; Value that uniquely identifies the category name.
    • CategoryName; string; Name of the category that classifies the item. A category groups items that possess similar characteristics, such as plastics, paints, inks, foods, and so on.
    • Comments; string; Comments provided when receiving the item.
    • ConsignedItems; string; Contains Y, N or empty. Y: the item is consigned. N: item is not consigned. The default value is N.
    • CurrencyCode; string; Abbreviation that identifies the currency, such as USD.
    • CurrencyConversionDate; string; Date to use when determining the rates to use when calculating the currency conversion.
    • CurrencyConversionRate; number; Rate to use when calculating the currency conversion.
    • CurrencyConversionType; string; Currency conversion type.
    • CustomerId; integer; Value that uniquely identifies the customer.
    • CustomerPartyName; string; Name of the party who purchases the item, typically for a fee.
    • DestinationType; string; Destination type for the item on the transaction line. It determines the accounting behavior of the transaction line. The RCV_DESTINATION_TYPE lookup defines the values that you can use with this attribute.
    • DestinationTypeCode; string; Abbreviation that identifies the destination type for the material on the transaction line. It determines the accounting behavior of the transaction line. The RCV_DESTINATION_TYPE lookup defines the values that you can use with this attribute.
    • DocumentDistributionNumber; integer; Distribution number for the document schedule. This attribute applies only for a purchase order or transfer order.
    • DocumentLineNumber; string; Line number for the document number.
    • DocumentNumber; string; Document number that identifies one of the following: the purchase order number for the purchase order, advance shipment notice, or advance shipment billing notice; the number for the return material authorization for the source document code of type RMA; the in-transit shipment number for the source document code of type INVENTORY; or the transfer order number for the source document code of type TRANSFER ORDER.
    • DocumentScheduleNumber; string; Schedule number for the document line number.
    • DocumentType; string; Document type according to the originating source, such as purchase order or return material authorization. The RCV_SOURCE_DOCUMENT_TYPE lookup defines the values that you can use with this attribute.
    • EmployeeId; integer; Value that uniquely identifies the employee.
    • EmployeeName; string; Name of the person who performed the transaction.
    • FromOrganizationCode; string; Abbreviation that identifies the organization that is the point of origin of the shipment. This value is empty for purchase orders and advanced shipment notices.
    • FromOrganizationId; integer; Value that uniquely identifies the organization that is the point of origin of the shipment. This value is empty for purchase orders and advance shipment notices.
    • FromOrganizationName; string; Name of the organization that is the point of origin of the shipment. This value is empty for purchase orders and advanced shipment notices.
    • InspectionStatus; string; Inspection status of the item. The RCV_INSPECTION_STATUS lookup defines the values that you can use with this attribute.
    • InspectionStatusCode; string; Abbreviation that identifies the inspection status code of the item. The RCV_INSPECTION_STATUS lookup defines the values that you can use with this attribute.
    • InventoryTransactionTypeId; integer; Value that uniquely identifies the inventory transaction type.
    • ItemDescription; string; Description of the item.
    • ItemId; integer; Value that uniquely identifies the item.
    • ItemNumber; string; Number that identifies the item to receive. This item is any part, material, product, or service that contains unique attributes when compared to other items.
    • ItemRevision; string; Revision of the item.
    • LineStatus; string; Current status of the received line, such as Received, Delivered, or Inspected. The RCV_LINE_STATUS lookup defines the values that you can use with this attribute.
    • Location; string; Physical location of the warehouse that receives items.
    • LocationId; integer; Value that uniquely identifies the receiving location.
    • Locator; string; Name of the locator where the item currently resides.
    • LocatorId; integer; Value that uniquely identifies the locator.
    • PODistributionId; integer; Value that uniquely identifies the purchase order distribution.
    • POHeaderId; integer; Value that uniquely identifies the purchase order header.
    • POLineId; integer; Value that uniquely identifies the purchase order line.
    • POLineLocationId; integer; Value that uniquely identifies the purchase order schedule.
    • PORevisionNumber; integer; Revision number of the purchase order.
    • ParentTransactionId; integer; Value that uniquely identifies the parent transaction.
    • ParentTransactionType; string; Transaction type of the parent transaction.
    • PrimaryUOMCode; string; Abbreviation that identifies the primary unit of measure that the item references.
    • Reason; string; Describes the rationale for classifying a transaction.
    • ReasonId; integer; Value that uniquely identifies the transaction reason.
    • ReceiptAdviceHeaderId; integer; Value that uniquely identifies the receipt advice header.
    • ReceiptAdviceLineId; integer; Value that uniquely identifies the receipt advice line.
    • ReceiptException; string; Contains Y, N, or empty. Y: the transaction contains an exception. N or empty: no exceptions.
    • ReceiptNumber; string; Number that identifies the receipt of the shipment in the warehouse.
    • ReceiptSourceCode; string; Source type of the shipment.
    • Routing; string; Routing name for the type of transaction entry that determines the steps that receive the item. The RCV_ROUTING_HEADERS lookup defines the values that you can use with this attribute.
    • RoutingHeaderId; integer; Value that uniquely identifies the receiving routing.
    • SecondaryAvailableQuantity; number; Quantity that is available to put away the parent transaction, using the secondary unit of measure.
    • SecondaryUOMCode; string; Abbreviation that identifies the secondary unit of measure to use for the quantity that is available to put away the parent transaction.
    • SecondaryUnitOfMeasure; string; Secondary unit of measure to use for the quantity that is available to put away the parent transaction.
    • ShipmentHeaderId; integer; Value that uniquely identifies the shipment header.
    • ShipmentLineId; integer; Value that uniquely identifies the shipment line.
    • SourceDocumentCode; string; Document type of the shipment. You can use one of the following values with this attribute: PO, RMA, TRANSFER ORDER, or INVENTORY.
    • Subinventory; string; Name of the subinventory where the item currently resides.
    • TOShipmentNumber; string; Number that identifies the transfer order shipment.
    • ToOrganizationCode; string; Abbreviation that identifies the ship-to organization of the line to put away.
    • ToOrganizationId; integer; Value that uniquely identifies the ship-to organization of the line to put away.
    • TransactionDate; string; Date when the transaction finished.
    • TransferOrderDistId; integer; Value that uniquely identifies the transfer order distribution.
    • TransferOrderHeaderId; integer; Value that uniquely identifies the transfer order header. Each transfer order can request to move items from one location to another location.
    • TransferOrderLineId; integer; Value that uniquely identifies the transfer order line.
    • UOMCode; string; Abbreviation that identifies the unit of measure to use for the quantity that is available to put away the parent transaction.
    • UnitOfMeasure; string; Unit of measure to use for the quantity that is available to put away the parent transaction.
    • VendorId; integer; Value that uniquely identifies the supplier.
    • VendorItemNumber; string; Number that the supplier uses to identify the item.
    • VendorName; string; Name of the party who provides a product in return for an item that might or might not require payment.
    • VendorSiteCode; string; Abbreviation that identifies the buying organization that conducts business with the supplier.
    • VendorSiteId; integer; Value that uniquely identifies the supplier site.
  • 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 : linesToPutAway
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : linesToPutAway-item-response
Type: object
Show Source
Nested Schema : Manufacturer Parts
Type: array
Title: Manufacturer Parts
The Manufacturer Parts resource manages the manufacturer parts associated with a receipt line.
Show Source
Nested Schema : linesToPutAway-manufacturerParts-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all lines to put away.

Example cURL Command

Use the following cURL command to submit a request on the REST resource. The following example gets all lines to put away in inventory organization M1, for purchase order 1000125, on purchase order line 1:

curl -u username:password "https://servername/fscmRestApi/resources/version/linesToPutAway?finder=findLines;bindOrganizationCode=M1,bindDocumentNumber=1000125,bindDocumentLineNumber=1,bindDocumentType=Purchase order"

Example Response Body

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

{
  "items" : [ {
    "ToOrganizationCode" : "M1",
    "ToOrganizationId" : 207,
    "FromOrganizationName" : null,
    "FromOrganizationCode" : null,
    "FromOrganizationId" : null,
    "ItemNumber" : "RCV-100",
    "ItemDescription" : "Plain Item",
    "ItemId" : 663907,
    "ItemRevision" : null,
    "ReceiptNumber" : "33747",
    "LineStatus" : "Received",
    "DocumentType" : "Purchase order",
    "SourceDocumentCode" : "PO",
    "DocumentNumber" : "1000125",
    "DocumentLineNumber" : "1",
    "DocumentScheduleNumber" : "1",
    "DocumentDistributionNumber" : 1,
    "TransactionDate" : "2016-05-31",
    "VendorName" : "First Network Devices",
    "VendorId" : 21,
    "VendorSiteCode" : "FRESNO",
    "VendorSiteId" : 1969,
    "VendorItemNumber" : null,
    "TOShipmentNumber" : null,
    "ASNNumber" : null,
    "ASNLineNumber" : null,
    "CustomerPartyName" : null,
    "CustomerId" : null,
    "AvailableQuantity" : 1,
    "UOMCode" : "Ea",
    "UnitOfMeasure" : "Each",
    "SecondaryAvailableQuantity" : 0,
    "SecondaryUOMCode" : null,
    "SecondaryUnitOfMeasure" : null,
    "DestinationType" : "Inventory",
    "DestinationTypeCode" : "INVENTORY",
    "Location" : "M1- Seattle Mfg",
    "LocationId" : 207,
    "Routing" : "Standard receipt",
    "RoutingHeaderId" : 1,
    "POHeaderId" : 100000012026081,
    "POLineLocationId" : 100000012026086,
    "POLineId" : 100000012026085,
    "PODistributionId" : 100000012026087,
    "PORevisionNumber" : 0,
    "ShipmentHeaderId" : 2883395,
    "ShipmentLineId" : 2963244,
    "TransferOrderHeaderId" : null,
    "TransferOrderLineId" : null,
    "TransferOrderDistId" : null,
    "ReceiptAdviceHeaderId" : null,
    "ReceiptAdviceLineId" : null,
    "ReceiptSourceCode" : "VENDOR",
    "ConsignedItems" : "N",
    "BackToBack" : "N",
    "CategoryName" : "Miscellaneous_1",
    "CategoryId" : 1,
    "CurrencyCode" : "USD",
    "CurrencyConversionRate" : null,
    "CurrencyConversionDate" : "2016-05-31",
    "CurrencyConversionType" : null,
    "InventoryTransactionTypeId" : 18,
    "ParentTransactionType" : "RECEIVE",
    "ParentTransactionId" : 3107402,
    "InspectionStatus" : "Not inspected",
    "InspectionStatusCode" : "NOT INSPECTED",
    "PrimaryUOMCode" : "Ea",
    "Reason" : null,
    "ReasonId" : null,
    "ReceiptException" : null,
    "EmployeeName" : "Oliver, Sam",
    "EmployeeId" : 300100036644754,
    "Comments" : null,
    "Subinventory" : null,
    "Locator" : null,
    "LocatorId" : null,
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername/fscmRestApi/resources/version/linesToPutAway/3107402",
      "name" : "linesToPutAway",
      "kind" : "item"
    }, {
      "rel" : "canonical",
      "href" : "https://servername/fscmRestApi/resources/version/linesToPutAway/3107402",
      "name" : "linesToPutAway",
      "kind" : "item"
  } ],
  "count" : 1,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/linesToPutAway",
    "name" : "linesToPutAway",
    "kind" : "collection"
  } ]
}
Back to Top