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

Get one line

get

/fscmRestApi/resources/11.13.18.05/linesToReceive/{linesToReceiveUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key--- SourceDocumentCode and DocumentLineId ---for the Lines to Receive resource and used to uniquely identify an instance of Lines to Receive. The client should not generate the hash key value. Instead, the client should query on the Lines to Receive collection resource with a filter on the primary key values in order to navigate to a specific instance of Lines to Receive.

    For example: linesToReceive?q=SourceDocumentCode=<value1>;DocumentLineId=<value2>
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : linesToReceive-item-response
Type: object
Show Source
  • Read Only: true
    Line number of the advanced shipment notice.
  • Read Only: true
    Maximum Length: 30
    Number that identifies the advanced shipment notice for the shipment from the supplier.
  • Read Only: true
    Quantity that is available to receive.
  • Read Only: true
    Maximum Length: 4
    Contains one of the following values: Y or N. If Y, then use back-to-back shipping. If N, then 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.
  • Read Only: true
    Value that uniquely identifies the category name.
  • Read Only: true
    Maximum Length: 250
    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.
  • Read Only: true
    Maximum Length: 4
    Contains one of the following values: Y or N. If Y, then the item is consigned. If N, then item is not consigned. The default value is N.
  • Read Only: true
    Maximum Length: 15
    Abbreviation that identifies the currency, such as USD.
  • Read Only: true
    Date to use when determining the rates to use when calculating the currency conversion.
  • Read Only: true
    Rate to use when calculating the currency conversion.
  • Read Only: true
    Maximum Length: 30
    Type of currency conversion.
  • Read Only: true
    Value that uniquely identifies the customer.
  • Read Only: true
    Maximum Length: 360
    Name of the party who purchases the product, typically for a fee.
  • Read Only: true
    Maximum Length: 80
    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.
  • Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the 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.
  • Read Only: true
    Distribution number for the document schedule. This attribute applies only for a purchase order or transfer order.
  • Read Only: true
    Value that uniquely identifies the document line.
  • Read Only: true
    Maximum Length: 30
    Line number for the document number.
  • Read Only: true
    Maximum Length: 30
    Number that identifies the document. This attribute 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.
  • Read Only: true
    Maximum Length: 80
    Schedule number for the document line number.
  • Read Only: true
    Maximum Length: 80
    Type of document according to the originating source, such as purchase order or return material authorization. A list of accepted values is defined in the lookup type RCV_SOURCE_DOCUMENT_TYPE.
  • Read Only: true
    Date when the warehouse expects to receive the item.
  • Read Only: true
    Maximum Length: 18
    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.
  • Read Only: true
    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.
  • Read Only: true
    Maximum Length: 240
    Name of the organization that is the point of origin of the shipment. This value is empty for purchase orders and advanced shipment notices.
  • Read Only: true
    Maximum Length: 4000
    Note to the receiver on the header.
  • Read Only: true
    Maximum Length: 25
    Status of integration for the line when communicating with an application that resides outside of Oracle. A list of accepted values is defined in the lookup type ORA_RCV_EXT_SYS_INTG_STATUS.
  • Read Only: true
    Value that uniquely identifies the inventory transaction type.
  • Read Only: true
    Maximum Length: 240
    Description of the item.
  • Read Only: true
    Value that uniquely identifies the item.
  • Read Only: true
    Maximum Length: 300
    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.
  • Read Only: true
    Maximum Length: 18
    Revision of the item.
  • Links
  • Manufacturer Parts
    Title: Manufacturer Parts
    The Manufacturer Parts resource manages the manufacturer parts associated with a receipt line.
  • Read Only: true
    Maximum Length: 25
    Describes the matching criteria to use for the invoice.
  • Read Only: true
    Quantity ordered on the document line.
  • Read Only: true
    Maximum Length: 25
    The unit of measure for the ordered quantity as per the document line.
  • Read Only: true
    Value that uniquely identifies the purchase order distribution.
  • Read Only: true
    Value that uniquely identifies the purchase order header.
  • Read Only: true
    Value that uniquely identifies the purchase order line.
  • Read Only: true
    Value that uniquely identifies the purchase order schedule.
  • Read Only: true
    Revision number of the purchase order.
  • Read Only: true
    Unit price on the document line.
  • Read Only: true
    Value that uniquely identifies the receipt advice header.
  • Read Only: true
    Value that uniquely identifies the receipt advice line.
  • Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the source type of the shipment.
  • Read Only: true
    Maximum Length: 80
    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.
  • Read Only: true
    Value that uniquely identifies the receiving routing.
  • Read Only: true
    Maximum Length: 4000
    Note to the receiver on the schedule.
  • Read Only: true
    Quantity that is available to receive, using the secondary unit of measure.
  • Read Only: true
    Maximum Length: 25
    Secondary unit of measure to use for the quantity that is available to receive.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the secondary unit of measure to use for the quantity that is available to receive.
  • Read Only: true
    Value that uniquely identifies the shipment header.
  • Read Only: true
    Value that uniquely identifies the shipment line.
  • Read Only: true
    Maximum Length: 60
    Physical location of the warehouse that receives the item.
  • Read Only: true
    Value that uniquely identifies the receiving location.
  • Read Only: true
    Maximum Length: 240
    Legal entity that is liable for the purchase order amount.
  • Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the document type of the shipment. Values include PO, RMA, TRANSFER ORDER, or INVENTORY.
  • Read Only: true
    Maximum Length: 80
    Application that captures the source document for the order line. The source system identifies the trading partner systems that receiving uses, such as Order Management Cloud, the customer of a logistics service, or an order management system that resides outside of Oracle.
  • Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the ship-to organization of the received line.
  • Read Only: true
    Value that uniquely identifies the ship-to organization of the received line.
  • Read Only: true
    Maximum Length: 30
    Number that identifies the transfer order shipment.
  • Read Only: true
    Value that uniquely identifies the transfer order distribution.
  • Read Only: true
    Value that uniquely identifies the transfer order header. Each transfer order can request to move items from one location to another location.
  • Read Only: true
    Value that uniquely identifies the transfer order line.
  • Read Only: true
    Maximum Length: 25
    Unit of measure to use for the quantity that is available to receive.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure to use for the quantity that is available to receive.
  • Read Only: true
    Value that uniquely identifies the vendor who supplies the item.
  • Read Only: true
    Maximum Length: 300
    Number that the supplier uses to identify the item.
  • Read Only: true
    Maximum Length: 240
    Name of the company that provides a product in return for an item that might or might not require payment.
  • Read Only: true
    Maximum Length: 240
    Abbreviation that identifies the buying organization that conducts business with the supplier.
  • Read Only: true
    Value that uniquely identifies the supplier site.
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 : linesToReceive-manufacturerParts-item-response
Type: object
Show Source
Links
manufacturerParts
Parameters:
  • linesToReceiveUniqID: $request.path.linesToReceiveUniqID
The Manufacturer Parts resource manages the manufacturer parts associated with a receipt line.
Back to Top

Examples

This example describes how to get one line to receive.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/linesToReceive?q=DocumentLineId=value"

For example, the following command gets one line to receive for document 100000015028304:

curl -u username:password "https://servername/fscmRestApi/resources/version/linesToReceive?q=DocumentLineId=100000015028304"

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": null,
"ItemDescription": "PEN",
"ItemId": null,
"ItemRevision": null,
"DocumentType": "Purchase order",
"SourceDocumentCode": "PO",
"DocumentNumber": "1000408",
"DocumentLineNumber": "1",
"DocumentScheduleNumber": "1",
"DocumentDistributionNumber": 1,
"SoldtoLegalEntity": "Vision Operations",
"SourceSystem": null,
"DocumentLineId": 100000015028304,
"DueDate": "2009-01-27",
"VendorName": "Star Gate Ltd",
"VendorSiteCode": "SAN JOSE-CTR_HQ",
"VendorId": 5,
"VendorSiteId": 2556,
"VendorItemNumber": "SG101",
"TOShipmentNumber": null,
"ASNNumber": null,
"ASNLineNumber": null,
"CustomerPartyName": null,
"CustomerId": null,
"AvailableQuantity": 100,
"UOMCode": "Ea",
"UnitOfMeasure": "Each",
"SecondaryAvailableQuantity": 0,
"SecondaryUOMCode": null,
"SecondaryUnitOfMeasure": null,
"DestinationType": "Expense",
"DestinationTypeCode": "EXPENSE",
"ShipToLocation": "M1- Seattle Mfg",
"ShipToLocationId": 207,
"Routing": "Direct delivery",
"RoutingHeaderId": 3,
"OrderedQuantity": 100,
"OrderedUnitOfMeasure": "Each",
"POHeaderId": 100000015028302,
"POLineLocationId": 100000015028305,
"POLineId": 100000015028304,
"PODistributionId": 100000015028306,
"PORevisionNumber": 0,
"ShipmentHeaderId": null,
"ShipmentLineId": null,
"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": null,
"CurrencyConversionType": null,
"InventoryTransactionTypeId": 18,
"POUnitPrice": 10,
"MatchOption": "P",
"HeaderNoteToReceiver": null,
"ScheduleNoteToReceiver": null,
"IntegrationStatus": "Ready to interface",
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
  {
"rel": "self",
"href": "https://servername/logisticsApi/resources/version/linesToReceive",
"name": "linesToReceive",
"kind": "collection"
}
],
}
Back to Top