1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. List of Values
  5. Receiving Receipt Expected Shipment Lines

Get all lines

get

/fscmRestApi/resources/11.13.18.05/receivingReceiptExpectedShipmentLines

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: Find expeced shipment lines according to the primary key.
      Finder Variables:
      • DocumentLineId; integer; Abbreviation that identifies the document type of the shipment. Values include PO, RMA, TRANSFER ORDER, or INVENTORY.
      • SourceDocumentCode; string; Value that uniquely identifies the receiving document line.
    • findLines: The following are the available finder names and corresponding finder variables
      Finder Variables:
      • bindASNNumber; string; Number that represents the Advanced Shipment Notice.
      • bindCustomer; string; Customer Party name.
      • bindFromDate; string; Start date of the time interval to use when finding the expeced shipment lines.
      • bindIntransitShipmentNumber; string; Number that represents the in-transit shipment.
      • bindItemNumber; string; Number that identifies the item to receive. An item is any part, material, product, or service that includes attributes that are unique when compared to other items.
      • bindOrganizationCode; string; Abbreviation that identifies the ship-to organization for the line.
      • bindPONumber; string; Number that uniquely identifies the purchase order header.
      • bindRMANumber; string; Numher that represents the return material authorization.
      • bindSupplier; string; Supplier name.
      • bindToDate; string; End date of the time interval to use when finding the expeced shipment lines.
      • bindTransferOrderNumber; string; Number that uniquely identifies the transfer order header.
  • 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:
    • ASNNumber; string; Number that uniquely identifies the advanced shipment notice.
    • CustomerId; number; Value that uniquely identifies the customer.
    • CustomerPartyName; string; Name of the party who purchases the product, typically for a fee.
    • DueDate; string; Date when the warehouse expects to receive the item.
    • FromOrganizationCode; string; Abbreviation that identifies the organization that is the point of origin of the in-transit shipment. This value is empty for purchase orders, RMAs and advanced shipment notices.
    • FromOrganizationId; number; 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.
    • IntransitShipmentNumber; string; Number that uniquely identifies the in-transit shipment header.
    • 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.
    • OrganizationCode; string; Abbreviation that identifies the ship-to organization of the expected shipment line.
    • OrganizationId; integer; Value that uniquely identifies the ship-to organization of the expected shipment line.
    • POHeaderId; number; Value that uniquely identifies the purchase order header.
    • POLineId; number; Value that uniquely identifies the purchase order line.
    • POLineLocationId; number; Value that uniquely identifies the purchase order schedule.
    • POLineNumber; number; Number that uniquely identifies the purchase order line.
    • PONumber; string; Number that uniquely identifies the purchase order header.
    • RADocumentCode; string; Abbreviation that identifies the document corresponding to the receipt advice.Always defaulted to RMA.
    • RMALineNumber; string; Number that uniquely identifies the return material authorization line.
    • RMANumber; string; Number that uniquely identifies the return material authorization header.
    • ReceiptAdviceHeaderId; number; Value that uniquely identifies the receipt advice header.
    • ReceiptAdviceLineId; number; Value that uniquely identifies the receipt advice line.
    • ShipmentHeaderId; number; Value that uniquely identifies the shipment header.
    • ShipmentLineId; number; Value that uniquely identifies the shipment line.
    • ShipmentLineNumber; number; Number that uniquely identifies the in-transit shipment line.
    • ToOrganizationId; integer; Value that uniquely identifies the ship-to organization of the expected shipment line.
    • TransferOrderHeaderId; number; Value that uniquely identifies the transfer order header. Each transfer order can request to move items from one location to another location.
    • TransferOrderLineId; number; Value that uniquely identifies the transfer order line.
    • TransferOrderLineNumber; string; Number that uniquely identifies the transfer order line.
    • TransferOrderNumber; string; Number that uniquely identifies the transfer order header.
    • VendorId; number; Value that uniquely identifies the vendor who supplies the item.
    • VendorName; string; Name of the company that 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; number; 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 : receivingReceiptExpectedShipmentLines
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : receivingReceiptExpectedShipmentLines-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 30
    Number that uniquely identifies the advanced shipment notice.
  • Read Only: true
    Quantity that is available to receive.
  • Read Only: true
    Maximum Length: 1
    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: 1
    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
    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: 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
    Value that represents the total number of distributions for the purchase order schedule or the transfer order line.
  • Read Only: true
    Value that uniquely identifies the document line.
  • Read Only: true
    Maximum Length: 80
    Line number for the document number.
  • Read Only: true
    Maximum Length: 80
    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
    Abbreviation that identifies the organization that is the point of origin of the in-transit shipment. This value is empty for purchase orders, RMAs 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: 1000
    Note to the receiver on the header.
  • Read Only: true
    Maximum Length: 30
    Number that uniquely identifies the in-transit shipment header.
  • 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: 4000
    URL for the primary image of the item being received.
  • Read Only: true
    Maximum Length: 18
    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.
  • Links
  • 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
    Maximum Length: 18
    Abbreviation that identifies the ship-to organization of the expected shipment line.
  • Read Only: true
    Value that uniquely identifies the ship-to organization of the expected shipment line.
  • 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
    Number that uniquely identifies the purchase order line.
  • Read Only: true
    Maximum Length: 30
    Number that uniquely identifies the purchase order header.
  • Read Only: true
    Number that uniquely identifies the purchase order schedule.
  • Read Only: true
    Unit price on the purchase order line.
  • Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the document corresponding to the receipt advice.Always defaulted to RMA.
  • 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
    Number that uniquely identifies the return material authorization line.
  • Read Only: true
    Maximum Length: 80
    Number that uniquely identifies the return material authorization header.
  • 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: 1000
    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
    Number that uniquely identifies the in-transit 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
    Value that uniquely identifies the ship-to organization of the expected shipment line.
  • 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: 40
    Number that uniquely identifies the transfer order line.
  • Read Only: true
    Maximum Length: 50
    Number that uniquely identifies the transfer order header.
  • 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: 360
    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.
Back to Top

Examples

Example 1

This example descibes how to get lines to receive using a purchase order number.

Example 1 cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines?q=OrganizationCode=value;PONumber=value"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines?q=OrganizationCode=M1;PONumber=1000250"

Example 1 Response Body

The following example includes the contents of the response body in JSON format: 
{
    "items": [
        {
            "OrganizationId": 207,
            "OrganizationCode": "M1",
            "ToOrganizationId": 207,
            "FromOrganizationCode": null,
            "FromOrganizationId": null,
            "ItemNumber": "zBIA_proc_CO_item_08",
            "ItemDescription": "zBIA_proc_CO_item_08",
            "ItemId": 100000012305083,
            "ItemRevision": null,
            "DocumentType": "Purchase order",
            "SourceDocumentCode": "PO",
            "SourceSystem": null,
            "DocumentLineId": 100000012303369,
            "SoldtoLegalEntity": "Vision Operations",
            "DocumentNumber": "1000250",
            "DocumentLineNumber": "1",
            "DocumentShipmentLineNumber": "1",
            "DistributionCount": 2,
            "PONumber": "1000250",
            "POLineNumber": 1,
            "POScheduleNumber": 1,
            "ASNNumber": null,
            "IntransitShipmentNumber": null,
            "ShipmentLineNumber": null,
            "TransferOrderNumber": null,
            "TransferOrderLineNumber": null,
            "RMANumber": null,
            "RMALineNumber": null,
            "DueDate": "2009-12-23",
            "VendorName": "GE Capital",
            "VendorSiteCode": "DANBURY",
            "VendorId": 2,
            "VendorSiteId": 2,
            "VendorItemNumber": null,
            "CustomerPartyName": null,
            "CustomerId": null,
            "AvailableQuantity": 110,
            "UOMCode": "Ea",
            "UnitOfMeasure": "Each",
            "SecondaryAvailableQuantity": null,
            "SecondaryUOMCode": null,
            "SecondaryUnitOfMeasure": null,
            "DestinationTypeCode": "EXPENSE",
            "ShipToLocation": "M1- Seattle Mfg",
            "ShipToLocationId": 207,
            "Routing": "Direct delivery",
            "RoutingHeaderId": 3,
            "OrderedQuantity": 110,
            "OrderedUnitOfMeasure": "Each",
            "POHeaderId": 100000012303365,
            "POLineId": 100000012303368,
            "POLineLocationId": 100000012303369,
            "ShipmentHeaderId": null,
            "ShipmentLineId": null,
            "TransferOrderHeaderId": null,
            "TransferOrderLineId": null,
            "ReceiptAdviceHeaderId": null,
            "ReceiptAdviceLineId": null,
            "ReceiptSourceCode": "VENDOR",
            "ConsignedItems": "N",
            "BackToBack": "N",
            "CategoryName": "Electrical Equipment and Supplies_616",
            "CategoryId": 616,
            "HeaderNoteToReceiver": null,
            "ScheduleNoteToReceiver": null,
            "RADocumentCode": null,
            "POUnitPrice": 50,
            "ItemPrimaryImageURL": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines/000200000002504F0000000EACED0005770800005AF31135FC09",
                    "name": "receivingReceiptExpectedShipmentLines",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines/000200000002504F0000000EACED0005770800005AF31135FC09",
                    "name": "receivingReceiptExpectedShipmentLines",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines",
            "name": "receivingReceiptExpectedShipmentLines",
            "kind": "collection"
        }
    ]
}

Example 2

This example descibes how to get lines to receive using a transfer order number.

Example 2 cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines?q=OrganizationCode=value;TransferOrderNumber=value"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines?q=OrganizationCode=M2;TransferOrderNumber=103001"

Example 2 Response Body

The following example includes the contents of the response body in JSON format: 
{
    "items": [
        {
            "OrganizationId": 209,
            "OrganizationCode": "M2",
            "ToOrganizationId": 209,
            "FromOrganizationCode": null,
            "FromOrganizationId": 207,
            "ItemNumber": "MMJCONS",
            "ItemDescription": "MMJCONS Plain Item",
            "ItemId": 300100073110561,
            "ItemRevision": null,
            "DocumentType": "Transfer order",
            "SourceDocumentCode": "TRANSFER ORDER",
            "SourceSystem": null,
            "DocumentLineId": 2918243,
            "SoldtoLegalEntity": null,
            "DocumentNumber": "103001",
            "DocumentLineNumber": "1",
            "DocumentShipmentLineNumber": null,
            "DistributionCount": 0,
            "PONumber": null,
            "POLineNumber": null,
            "POScheduleNumber": null,
            "ASNNumber": null,
            "IntransitShipmentNumber": "2238847",
            "ShipmentLineNumber": 1,
            "TransferOrderNumber": "103001",
            "TransferOrderLineNumber": "1",
            "RMANumber": null,
            "RMALineNumber": null,
            "DueDate": "2015-12-07",
            "VendorName": null,
            "VendorSiteCode": null,
            "VendorId": null,
            "VendorSiteId": null,
            "VendorItemNumber": null,
            "CustomerPartyName": null,
            "CustomerId": null,
            "AvailableQuantity": 11,
            "UOMCode": "Ea",
            "UnitOfMeasure": "Each",
            "SecondaryAvailableQuantity": null,
            "SecondaryUOMCode": null,
            "SecondaryUnitOfMeasure": null,
            "DestinationTypeCode": "INVENTORY",
            "ShipToLocation": "M2- Boston",
            "ShipToLocationId": 209,
            "Routing": "Standard receipt",
            "RoutingHeaderId": 1,
            "OrderedQuantity": 15,
            "OrderedUnitOfMeasure": "Each",
            "POHeaderId": null,
            "POLineId": null,
            "POLineLocationId": null,
            "ShipmentHeaderId": 2839394,
            "ShipmentLineId": 2918243,
            "TransferOrderHeaderId": 300100071638146,
            "TransferOrderLineId": 3001,
            "ReceiptAdviceHeaderId": null,
            "ReceiptAdviceLineId": null,
            "ReceiptSourceCode": "TRANSFER ORDER",
            "ConsignedItems": "N",
            "BackToBack": "N",
            "CategoryName": null,
            "CategoryId": null,
            "HeaderNoteToReceiver": null,
            "ScheduleNoteToReceiver": null,
            "RADocumentCode": null,
            "POUnitPrice": null,
            "ItemPrimaryImageURL": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines/00020000000E5452414E53464552204F524445520000000EACED0005770800000000002C8763",
                    "name": "receivingReceiptExpectedShipmentLines",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines/00020000000E5452414E53464552204F524445520000000EACED0005770800000000002C8763",
                    "name": "receivingReceiptExpectedShipmentLines",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines",
            "name": "receivingReceiptExpectedShipmentLines",
            "kind": "collection"
        }
    ]
}

Example 3

This example descibes how to get lines to receive using an advanced shipment notice (ASN) number.

Example 3 cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines?q=OrganizationCode=value;ASNNumber=value"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines?q=OrganizationCode=V1;ASNNumber= zOTBI_ASN_2009_1201"

Example 3 Response Body

The following example includes the contents of the response body in JSON format: 
{
    "items": [
        {
            "OrganizationId": 204,
            "OrganizationCode": "V1",
            "ToOrganizationId": 204,
            "FromOrganizationCode": null,
            "FromOrganizationId": null,
            "ItemNumber": "zBIA_req_item_03",
            "ItemDescription": "zBIA_Requisition Purchase Item_03",
            "ItemId": 100000012065950,
            "ItemRevision": null,
            "DocumentType": "Purchase order",
            "SourceDocumentCode": "PO",
            "SourceSystem": null,
            "DocumentLineId": 2966256,
            "SoldtoLegalEntity": "Vision Operations",
            "DocumentNumber": "1000455",
            "DocumentLineNumber": "1",
            "DocumentShipmentLineNumber": "1",
            "DistributionCount": 1,
            "PONumber": "1000455",
            "POLineNumber": 1,
            "POScheduleNumber": 1,
            "ASNNumber": "zOTBI_ASN_2009_1201",
            "IntransitShipmentNumber": null,
            "ShipmentLineNumber": 1,
            "TransferOrderNumber": null,
            "TransferOrderLineNumber": null,
            "RMANumber": null,
            "RMALineNumber": null,
            "DueDate": "2009-12-30",
            "VendorName": "CV_SuppA01",
            "VendorSiteCode": "CVSuppA01Site01",
            "VendorId": 12,
            "VendorSiteId": 2444,
            "VendorItemNumber": null,
            "CustomerPartyName": null,
            "CustomerId": null,
            "AvailableQuantity": 5,
            "UOMCode": "LBS",
            "UnitOfMeasure": "LBS",
            "SecondaryAvailableQuantity": null,
            "SecondaryUOMCode": null,
            "SecondaryUnitOfMeasure": null,
            "DestinationTypeCode": "INVENTORY",
            "ShipToLocation": "MRO Location 2",
            "ShipToLocationId": 10884,
            "Routing": "Standard receipt",
            "RoutingHeaderId": 1,
            "OrderedQuantity": 5,
            "OrderedUnitOfMeasure": "LBS",
            "POHeaderId": 100000015118954,
            "POLineId": 100000015118955,
            "POLineLocationId": 100000015118956,
            "ShipmentHeaderId": 2889407,
            "ShipmentLineId": 2966256,
            "TransferOrderHeaderId": null,
            "TransferOrderLineId": null,
            "ReceiptAdviceHeaderId": null,
            "ReceiptAdviceLineId": null,
            "ReceiptSourceCode": "VENDOR",
            "ConsignedItems": "N",
            "BackToBack": "N",
            "CategoryName": "Cable, Other",
            "CategoryId": 3037,
            "HeaderNoteToReceiver": null,
            "ScheduleNoteToReceiver": null,
            "RADocumentCode": null,
            "POUnitPrice": 50,
            "ItemPrimaryImageURL": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines/000200000002504F0000000EACED0005770800000000002D42F0",
                    "name": "receivingReceiptExpectedShipmentLines",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines/000200000002504F0000000EACED0005770800000000002D42F0",
                    "name": "receivingReceiptExpectedShipmentLines",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines",
            "name": "receivingReceiptExpectedShipmentLines",
            "kind": "collection"
        }
    ]
}

Example 4

This example descibes how to get lines to receive using a return material authorization (RMA) number.

Example 4 cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines?q=OrganizationCode=value;RMANumber=value"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines?q=OrganizationCode=M2;RMANumber=1266994894"

Example 4 Response Body

The following example includes the contents of the response body in JSON format: 
{
    "items": [
        {
            "OrganizationId": 209,
            "OrganizationCode": "M2",
            "ToOrganizationId": 209,
            "FromOrganizationCode": null,
            "FromOrganizationId": null,
            "ItemNumber": "AU11888",
            "ItemDescription": "Drive Mount Assy",
            "ItemId": 1056,
            "ItemRevision": null,
            "DocumentType": "Return material authorization",
            "SourceDocumentCode": "RMA",
            "SourceSystem": "SIEBEL",
            "DocumentLineId": 2823956,
            "SoldtoLegalEntity": null,
            "DocumentNumber": "1266994894",
            "DocumentLineNumber": "1",
            "DocumentShipmentLineNumber": null,
            "DistributionCount": 0,
            "PONumber": null,
            "POLineNumber": null,
            "POScheduleNumber": null,
            "ASNNumber": null,
            "IntransitShipmentNumber": null,
            "ShipmentLineNumber": null,
            "TransferOrderNumber": null,
            "TransferOrderLineNumber": null,
            "RMANumber": "1266994894",
            "RMALineNumber": "1",
            "DueDate": "2001-02-23",
            "VendorName": null,
            "VendorSiteCode": null,
            "VendorId": null,
            "VendorSiteId": null,
            "VendorItemNumber": null,
            "CustomerPartyName": "Computer Service and Rentals",
            "CustomerId": 1006,
            "AvailableQuantity": 10,
            "UOMCode": "Ea",
            "UnitOfMeasure": "Each",
            "SecondaryAvailableQuantity": null,
            "SecondaryUOMCode": null,
            "SecondaryUnitOfMeasure": null,
            "DestinationTypeCode": "RECEIVING",
            "ShipToLocation": "M2- Boston",
            "ShipToLocationId": 209,
            "Routing": "Direct delivery",
            "RoutingHeaderId": 3,
            "OrderedQuantity": null,
            "OrderedUnitOfMeasure": "Each",
            "POHeaderId": null,
            "POLineId": null,
            "POLineLocationId": null,
            "ShipmentHeaderId": null,
            "ShipmentLineId": null,
            "TransferOrderHeaderId": null,
            "TransferOrderLineId": null,
            "ReceiptAdviceHeaderId": 2743296,
            "ReceiptAdviceLineId": 2823956,
            "ReceiptSourceCode": "CUSTOMER",
            "ConsignedItems": "N",
            "BackToBack": "N",
            "CategoryName": null,
            "CategoryId": null,
            "HeaderNoteToReceiver": null,
            "ScheduleNoteToReceiver": null,
            "RADocumentCode": "RMA",
            "POUnitPrice": null,
            "ItemPrimaryImageURL": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines/000200000003524D410000000EACED0005770800000000002B1714",
                    "name": "receivingReceiptExpectedShipmentLines",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines/000200000003524D410000000EACED0005770800000000002B1714",
                    "name": "receivingReceiptExpectedShipmentLines",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines",
            "name": "receivingReceiptExpectedShipmentLines",
            "kind": "collection"
        }
    ]
}

Example 5

This example descibes how to get lines to receive using an in-transit shipment number.

Example 5 cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines?q=OrganizationCode=value;IntransitShipmentNumber=value"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines?q=OrganizationCode=D1;IntransitShipmentNumber=1045"

Example 5 Response Body

The following example includes the contents of the response body in JSON format: 
{
    "items": [
        {
            "OrganizationId": 229,
            "OrganizationCode": "D1",
            "ToOrganizationId": 229,
            "FromOrganizationCode": null,
            "FromOrganizationId": 210,
            "ItemNumber": "AS54888",
            "ItemDescription": "Sentinel Standard",
            "ItemId": 149,
            "ItemRevision": null,
            "DocumentType": "In-transit shipment",
            "SourceDocumentCode": "INVENTORY",
            "SourceSystem": null,
            "DocumentLineId": 193,
            "SoldtoLegalEntity": null,
            "DocumentNumber": "1045",
            "DocumentLineNumber": "1",
            "DocumentShipmentLineNumber": null,
            "DistributionCount": 0,
            "PONumber": null,
            "POLineNumber": null,
            "POScheduleNumber": null,
            "ASNNumber": null,
            "IntransitShipmentNumber": "1045",
            "ShipmentLineNumber": 1,
            "TransferOrderNumber": null,
            "TransferOrderLineNumber": null,
            "RMANumber": null,
            "RMALineNumber": null,
            "DueDate": "1997-08-17",
            "VendorName": null,
            "VendorSiteCode": null,
            "VendorId": null,
            "VendorSiteId": null,
            "VendorItemNumber": null,
            "CustomerPartyName": null,
            "CustomerId": null,
            "AvailableQuantity": 10,
            "UOMCode": "Ea",
            "UnitOfMeasure": "Each",
            "SecondaryAvailableQuantity": null,
            "SecondaryUOMCode": null,
            "SecondaryUnitOfMeasure": null,
            "DestinationTypeCode": "INVENTORY",
            "ShipToLocation": null,
            "ShipToLocationId": null,
            "Routing": "Standard receipt",
            "RoutingHeaderId": 1,
            "OrderedQuantity": 10,
            "OrderedUnitOfMeasure": "Each",
            "POHeaderId": null,
            "POLineId": null,
            "POLineLocationId": null,
            "ShipmentHeaderId": 200,
            "ShipmentLineId": 193,
            "TransferOrderHeaderId": null,
            "TransferOrderLineId": null,
            "ReceiptAdviceHeaderId": null,
            "ReceiptAdviceLineId": null,
            "ReceiptSourceCode": "INVENTORY",
            "ConsignedItems": "N",
            "BackToBack": "N",
            "CategoryName": null,
            "CategoryId": null,
            "HeaderNoteToReceiver": null,
            "ScheduleNoteToReceiver": null,
            "RADocumentCode": null,
            "POUnitPrice": null,
            "ItemPrimaryImageURL": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines/000200000009494E56454E544F52590000000EACED0005770800000000000000C1",
                    "name": "receivingReceiptExpectedShipmentLines",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines/000200000009494E56454E544F52590000000EACED0005770800000000000000C1",
                    "name": "receivingReceiptExpectedShipmentLines",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines",
            "name": "receivingReceiptExpectedShipmentLines",
            "kind": "collection"
        }
    ]
}

Example 6

This example descibes how to get lines to receive using a vendor name.

Example 6 cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines?q=OrganizationCode=value;VendorName=value"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines?q=OrganizationCode=M1;VendorName=cPO-Supplier12"

Example 6 Response Body

The following example includes the contents of the response body in JSON format: 
{
    "items": [
        {
            "OrganizationId": 207,
            "OrganizationCode": "M1",
            "ToOrganizationId": 207,
            "FromOrganizationCode": null,
            "FromOrganizationId": null,
            "ItemNumber": "zBIA_proc_item_15",
            "ItemDescription": "zBIA_Purchase Item_15",
            "ItemId": 100000012073484,
            "ItemRevision": "A",
            "DocumentType": "Purchase order",
            "SourceDocumentCode": "PO",
            "SourceSystem": null,
            "DocumentLineId": 100000012303758,
            "SoldtoLegalEntity": "Vision Operations",
            "DocumentNumber": "1000262",
            "DocumentLineNumber": "1",
            "DocumentShipmentLineNumber": "2",
            "DistributionCount": 1,
            "PONumber": "1000262",
            "POLineNumber": 1,
            "POScheduleNumber": 2,
            "ASNNumber": null,
            "IntransitShipmentNumber": null,
            "ShipmentLineNumber": null,
            "TransferOrderNumber": null,
            "TransferOrderLineNumber": null,
            "RMANumber": null,
            "RMALineNumber": null,
            "DueDate": "2009-12-13",
            "VendorName": "cPO-Supplier12",
            "VendorSiteCode": "cPO-SITE01",
            "VendorId": 100000011548050,
            "VendorSiteId": 100000011548088,
            "VendorItemNumber": "zBIA_Supplier_Item_15",
            "CustomerPartyName": null,
            "CustomerId": null,
            "AvailableQuantity": 59,
            "UOMCode": "M",
            "UnitOfMeasure": "Meter",
            "SecondaryAvailableQuantity": null,
            "SecondaryUOMCode": null,
            "SecondaryUnitOfMeasure": null,
            "DestinationTypeCode": "EXPENSE",
            "ShipToLocation": "M1- Seattle Mfg",
            "ShipToLocationId": 207,
            "Routing": "Direct delivery",
            "RoutingHeaderId": 3,
            "OrderedQuantity": 60,
            "OrderedUnitOfMeasure": "Meter",
            "POHeaderId": 100000012303728,
            "POLineId": 100000012303748,
            "POLineLocationId": 100000012303758,
            "ShipmentHeaderId": null,
            "ShipmentLineId": null,
            "TransferOrderHeaderId": null,
            "TransferOrderLineId": null,
            "ReceiptAdviceHeaderId": null,
            "ReceiptAdviceLineId": null,
            "ReceiptSourceCode": "VENDOR",
            "ConsignedItems": "N",
            "BackToBack": "N",
            "CategoryName": "Facilities Supplies",
            "CategoryId": 37,
            "HeaderNoteToReceiver": null,
            "ScheduleNoteToReceiver": null,
            "RADocumentCode": null,
            "POUnitPrice": 110,
            "ItemPrimaryImageURL": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines/000200000002504F0000000EACED0005770800005AF31135FD8E",
                    "name": "receivingReceiptExpectedShipmentLines",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines/000200000002504F0000000EACED0005770800005AF31135FD8E",
                    "name": "receivingReceiptExpectedShipmentLines",
                    "kind": "item"
                }
            ]
        }],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines",
            "name": "receivingReceiptExpectedShipmentLines",
            "kind": "collection"
        }
    ]
}

Example 7

This example descibes how to get lines to receive using a due date.

Example 7 cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines?q=OrganizationCode=value;DueDate=value"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines?q=OrganizationCode=M1;DueDate=2023-08-16"

Example 7 Response Body

The following example includes the contents of the response body in JSON format: 
{
    "items": [
        {
            "OrganizationId": 207,
            "OrganizationCode": "M1",
            "ToOrganizationId": 207,
            "FromOrganizationCode": null,
            "FromOrganizationId": null,
            "ItemNumber": "SCO_ATO_Model_ML_BUY*1010*SCO_ATO_Model_ML_BUY",
            "ItemDescription": "SCO_ATO_Model_ML_BUY",
            "ItemId": 300100148051712,
            "ItemRevision": null,
            "DocumentType": "Purchase order",
            "SourceDocumentCode": "PO",
            "SourceSystem": null,
            "DocumentLineId": 300100586934036,
            "SoldtoLegalEntity": "Vision Operations",
            "DocumentNumber": "1007184",
            "DocumentLineNumber": "1",
            "DocumentShipmentLineNumber": "2",
            "DistributionCount": 1,
            "PONumber": "1007184",
            "POLineNumber": 1,
            "POScheduleNumber": 2,
            "ASNNumber": null,
            "IntransitShipmentNumber": null,
            "ShipmentLineNumber": null,
            "TransferOrderNumber": null,
            "TransferOrderLineNumber": null,
            "RMANumber": null,
            "RMALineNumber": null,
            "DueDate": "2023-08-16",
            "VendorName": "SCO_SUPPLIER",
            "VendorSiteCode": "SCO_SITE",
            "VendorId": 300100052570626,
            "VendorSiteId": 300100052570638,
            "VendorItemNumber": null,
            "CustomerPartyName": null,
            "CustomerId": null,
            "AvailableQuantity": 4,
            "UOMCode": "Ea",
            "UnitOfMeasure": "Each",
            "SecondaryAvailableQuantity": null,
            "SecondaryUOMCode": null,
            "SecondaryUnitOfMeasure": null,
            "DestinationTypeCode": "INVENTORY",
            "ShipToLocation": "M1- Seattle Mfg",
            "ShipToLocationId": 207,
            "Routing": "Standard receipt",
            "RoutingHeaderId": 1,
            "OrderedQuantity": 4,
            "OrderedUnitOfMeasure": "Each",
            "POHeaderId": 300100586832455,
            "POLineId": 300100586832461,
            "POLineLocationId": 300100586934036,
            "ShipmentHeaderId": null,
            "ShipmentLineId": null,
            "TransferOrderHeaderId": null,
            "TransferOrderLineId": null,
            "ReceiptAdviceHeaderId": null,
            "ReceiptAdviceLineId": null,
            "ReceiptSourceCode": "VENDOR",
            "ConsignedItems": "N",
            "BackToBack": "Y",
            "CategoryName": "Miscellaneous_1",
            "CategoryId": 1,
            "HeaderNoteToReceiver": null,
            "ScheduleNoteToReceiver": null,
            "RADocumentCode": null,
            "POUnitPrice": 400,
            "ItemPrimaryImageURL": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines/000200000002504F0000000EACED00057708000110F09CE18F14",
                    "name": "receivingReceiptExpectedShipmentLines",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines/000200000002504F0000000EACED00057708000110F09CE18F14",
                    "name": "receivingReceiptExpectedShipmentLines",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptExpectedShipmentLines",
            "name": "receivingReceiptExpectedShipmentLines",
            "kind": "collection"
        }
    ]
}
Back to Top