Jump to

• Request
• Response
• Examples

Get all lines

get

/fscmRestApi/resources/11.13.18.05/receivingReceiptPutAwayLines

Request

Query Parameters

• expand: string
  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).
• fields: string
  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
• finder: string
  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 received lines eligible for put away according to the primary key.
    Finder Variables:
    • ParentTransactionId; integer; Value that uniquely identifies the parent transaction.
  • findLines: Finds received lines that are available to put away according to the bind variables that you provide.
    Finder Variables:
    • bindASNNumber; string; Number that represents the advance shipment notice.
    • bindFromDate; string; Start date of the time interval of the parent transaction date.
    • bindIntransitShipmentNumber; string; Number that represents the in-transit shipment.
    • 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.
    • bindPONumber; string; Number that uniquely identifies the purchase order header.
    • bindRMANumber; string; Numher that represents the return material authorization.
    • bindReceiptNumber; string; Number that acknowledges that the warehouse received a shipment.
    • bindToDate; string; End date of the time interval of the parent transaction date.
    • bindTransferOrderNumber; string; Number that uniquely identifies the transfer order header.
• limit: integer
  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.
• links: string
  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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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 advance shipment notice.
  • 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's the point of origin of the in-transit shipment. This value is empty for purchase orders, RMAs, and advance shipment notices.
  • FromOrganizationId; integer; Value that uniquely identifies the organization that's the point of origin of the in-transit shipment. This value is empty for purchase orders, RMAs and advance shipment notices.
  • 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.
  • 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 of the received line. This item is any part, material, product, or service that contains unique attributes when compared to other items.
  • OrganizationCode; string; Abbreviation that uniquely identifies the organization where the line was received.
  • OrganizationId; integer; Value that uniquely identifies the organization where the line was received.
  • 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.
  • POLineNumber; string; Number that uniquely identifies the purchase order line.
  • PONumber; string; Number that uniquely identifies the purchase order header.
  • ParentTransactionId; integer; Value that uniquely identifies the parent transaction.
  • 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; integer; Value that uniquely identifies the receipt advice header.
  • ReceiptAdviceLineId; integer; Value that uniquely identifies the receipt advice line.
  • ReceiptNumber; string; Number that identifies the receipt of the shipment in the warehouse.
  • ShipmentHeaderId; integer; Value that uniquely identifies the shipment header.
  • ShipmentLineId; integer; Value that uniquely identifies the shipment line.
  • ShipmentLineNumber; string; Number that uniquely identifies the in-transit shipment line.
  • TransactionDate; string; Date when the receiving document line was received in the warehouse.
  • 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.
  • TransferOrderLineNumber; string; Number that uniquely identifies the transfer order line.
  • TransferOrderNumber; string; Number that uniquely identifies the transfer order header.
• totalResults: boolean
  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

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  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 : receivingReceiptPutAwayLines

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/receivingReceiptPutAwayLines-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"InventoryManagement",
        "usage":"LOV",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object receivingReceiptPutAwayLines-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/receivingReceiptPutAwayLines-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : receivingReceiptPutAwayLines-item-response

Type: object

Show Source

• ASNNumber: string
  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the advance shipment notice.
• AvailableQuantity: number
  Read Only: true

  Quantity that's available to put away.
• BackToBack: string
  Read Only: true

  Maximum Length: 25

  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.
• ConsignedItems: string
  Read Only: true

  Maximum Length: 18

  Contains one of the following values: Y or N. If Y, then the item is consigned. If N, then the item is not consigned. The default value is N.
• CustomerId: integer (int64)
  Read Only: true

  Value that uniquely identifies the customer.
• CustomerPartyName: string
  Read Only: true

  Maximum Length: 360

  Name of the party that purchases the product, typically for a fee.
• DestinationTypeCode: string
  Read Only: true

  Maximum Length: 3

  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.
• DistributionCount: integer (int64)
  Read Only: true

  Value that represents the total number of distributions for the purchase order schedule or the transfer order line.
• DocumentLineNumber: string
  Read Only: true

  Maximum Length: 80

  Line number for the document number.
• DocumentNumber: string
  Read Only: true

  Maximum Length: 80

  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.
• DocumentShipmentLineNumber: string
  Read Only: true

  Maximum Length: 80

  Schedule number for the document line number.
• DocumentType: string
  Read Only: true

  Maximum Length: 80

  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 (int64)
  Read Only: true

  Value that uniquely identifies the employee.
• EmployeeName: string
  Read Only: true

  Maximum Length: 80

  Name of the person who performed the transaction.
• FromOrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the organization that's the point of origin of the in-transit shipment. This value is empty for purchase orders, RMAs, and advance shipment notices.
• FromOrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization that's the point of origin of the in-transit shipment. This value is empty for purchase orders, RMAs and advance shipment notices.
• InspectionStatus: string
  Read Only: true

  Maximum Length: 25

  Inspection status of the item. The RCV_INSPECTION_STATUS lookup defines the values that you can use with this attribute.
• InspectionStatusCode: string
  Read Only: true

  Maximum Length: 18

  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.
• IntransitShipmentNumber: string
  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the in-transit shipment header.
• ItemDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the item.
• ItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number that identifies the item of the received line. This item is any part, material, product, or service that contains unique attributes when compared to other items.
• ItemPrimaryImageURL: string
  Read Only: true

  Maximum Length: 4000

  URL for the primary image of the item being received.
• ItemRevision: string
  Read Only: true

  Maximum Length: 18

  Revision of the item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that uniquely identifies the organization where the line was received.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization where the line was received.
• ParentTransactionId: integer (int32)
  Read Only: true

  Value that uniquely identifies the parent transaction.
• ParentTransactionType: string
  Read Only: true

  Maximum Length: 1

  Transaction type of the parent transaction.
• POHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase order header.
• POLineId: integer
  Read Only: true

  Value that uniquely identifies the purchase order line.
• POLineLocationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase order schedule.
• POLineNumber: string
  Read Only: true

  Number that uniquely identifies the purchase order line.
• PONumber: string
  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the purchase order header.
• POScheduleNumber: string
  Read Only: true

  Number that uniquely identifies the purchase order schedule.
• RADocumentCode: string
  Read Only: true

  Maximum Length: 2000

  Abbreviation that identifies the document corresponding to the receipt advice. Always defaulted to RMA.
• ReceiptAdviceHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the receipt advice header.
• ReceiptAdviceLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the receipt advice line.
• ReceiptNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the receipt of the shipment in the warehouse.
• ReceiptSourceCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the source type of the shipment.
• RMALineNumber: string
  Read Only: true

  Maximum Length: 80

  Number that uniquely identifies the return material authorization line.
• RMANumber: string
  Read Only: true

  Maximum Length: 80

  Number that uniquely identifies the return material authorization header.
• SecondaryAvailableQuantity: number
  Read Only: true

  Quantity that's available to put away using the secondary unit of measure.
• SecondaryUnitOfMeasure: string
  Read Only: true

  Maximum Length: 25

  Secondary unit of measure to use for the quantity that's available to put away the parent transaction.
• SecondaryUOMCode: string
  Read Only: true

  Abbreviation that identifies the secondary unit of measure to use for the quantity that's available to receive.
• ShipmentHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the shipment header.
• ShipmentLineId: integer
  Read Only: true

  Value that uniquely identifies the shipment line.
• ShipmentLineNumber: string
  Read Only: true

  Maximum Length: 18

  Number that uniquely identifies the in-transit shipment line.
• SourceDocumentCode: string
  Read Only: true

  Maximum Length: 25

  Document type of the shipment. You can use one of the following values with this attribute: PO, RMA, TRANSFER ORDER, or INVENTORY.
• TransactionDate: string (date)
  Read Only: true

  Date when the receiving document line was received in the warehouse.
• TransferOrderHeaderId: integer (int64)
  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.
• TransferOrderLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the transfer order line.
• TransferOrderLineNumber: string
  Read Only: true

  Maximum Length: 40

  Number that uniquely identifies the transfer order line.
• TransferOrderNumber: string
  Read Only: true

  Maximum Length: 50

  Number that uniquely identifies the transfer order header.
• UnitOfMeasure: string
  Read Only: true

  Maximum Length: 25

  Unit of measure to use for the quantity that's available to put away the parent transaction.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure to use for the quantity that's available to put away.
• VendorId: integer (int64)
  Read Only: true

  Abbreviation that identifies the buying organization that conducts business with the supplier.
• VendorItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number that the supplier uses to identify the item.
• VendorName: string
  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.
• VendorSiteCode: string
  Read Only: true

  Maximum Length: 240

  Value that uniquely identifies the vendor who supplies the item.
• VendorSiteId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier site.

{
    "type":"object",
    "properties":{
        "PONumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the purchase order header.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ASNNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the advance shipment notice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionStatusCode":{
            "maxLength":18,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Secondary unit of measure to use for the quantity that's available to put away the parent transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "POLineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order schedule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":25
            },
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AvailableQuantity":{
            "type":"number",
            "description":"Quantity that's available to put away.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReceiptSourceCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the source type of the shipment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RMANumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifies the return material authorization header.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentLineNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Line number for the document number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemRevision":{
            "maxLength":18,
            "type":"string",
            "description":"Revision of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "POLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipmentLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipment line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VendorSiteCode":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the vendor who supplies the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure to use for the quantity that's available to put away.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReceiptNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the receipt of the shipment in the warehouse.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FromOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization that's the point of origin of the in-transit shipment. This value is empty for purchase orders, RMAs and advance shipment notices.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VendorName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the company that provides a product in return for an item that might or might not require payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TransferOrderLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transfer order line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure to use for the quantity that's available to put away the parent transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "VendorSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RADocumentCode":{
            "maxLength":2000,
            "type":"string",
            "description":"Abbreviation that identifies the document corresponding to the receipt advice. Always defaulted to RMA.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent transaction.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "SourceDocumentCode":{
            "maxLength":25,
            "type":"string",
            "description":"Document type of the shipment. You can use one of the following values with this attribute: PO, RMA, TRANSFER ORDER, or INVENTORY.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmployeeName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the person who performed the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VendorItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that the supplier uses to identify the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CustomerPartyName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the party that purchases the product, typically for a fee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FromOrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the organization that's the point of origin of the in-transit shipment. This value is empty for purchase orders, RMAs, and advance shipment notices.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VendorId":{
            "type":"integer",
            "description":"Abbreviation that identifies the buying organization that conducts business with the supplier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RMALineNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifies the return material authorization line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptAdviceLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receipt advice line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization where the line was received.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DocumentShipmentLineNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Schedule number for the document line number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InspectionStatus":{
            "maxLength":25,
            "type":"string",
            "description":"Inspection status of the item. The RCV_INSPECTION_STATUS lookup defines the values that you can use with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "POScheduleNumber":{
            "type":"string",
            "description":"Number that uniquely identifies the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the item of the received line. This item is any part, material, product, or service that contains unique attributes when compared to other items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryAvailableQuantity":{
            "type":"number",
            "description":"Quantity that's available to put away using the secondary unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "POHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":25
            },
            "x-queryable":true
        },
        "BackToBack":{
            "maxLength":25,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SecondaryUOMCode":{
            "type":"string",
            "description":"Abbreviation that identifies the secondary unit of measure to use for the quantity that's available to receive.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the organization where the line was received.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemPrimaryImageURL":{
            "maxLength":4000,
            "type":"string",
            "description":"URL for the primary image of the item being received.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipmentLineNumber":{
            "maxLength":18,
            "type":"string",
            "description":"Number that uniquely identifies the in-transit shipment line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmployeeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the employee.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":25
            },
            "x-queryable":true
        },
        "TransferOrderHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transfer order header. Each transfer order can request to move items from one location to another location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionDate":{
            "type":"string",
            "description":"Date when the receiving document line was received in the warehouse.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationTypeCode":{
            "maxLength":3,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DocumentType":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ConsignedItems":{
            "maxLength":18,
            "type":"string",
            "description":"Contains one of the following values: Y or N. If Y, then the item is consigned. If N, then the item is not consigned. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipmentHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipment header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DistributionCount":{
            "type":"integer",
            "description":"Value that represents the total number of distributions for the purchase order schedule or the transfer order line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DocumentNumber":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TransferOrderNumber":{
            "maxLength":50,
            "type":"string",
            "description":"Number that uniquely identifies the transfer order header.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptAdviceHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receipt advice header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentTransactionType":{
            "maxLength":1,
            "type":"string",
            "description":"Transaction type of the parent transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "POLineNumber":{
            "type":"string",
            "description":"Number that uniquely identifies the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntransitShipmentNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the in-transit shipment header.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransferOrderLineNumber":{
            "maxLength":40,
            "type":"string",
            "description":"Number that uniquely identifies the transfer order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : properties

Type: object

Show Source

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

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

Back to Top

Examples

Example 1

This example descibes how to get lines to put away 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/receivingReceiptPutAwayLines?q=OrganizationCode=value;PONumber=value"

For example:

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

Example 1 Response Body

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

{
    "items": [
        {
            "OrganizationId": 207,
            "OrganizationCode": "M1",
            "FromOrganizationCode": null,
            "FromOrganizationId": null,
            "ItemNumber": "RCV-100",
            "ItemDescription": "Plain Item",
            "ItemId": 663907,
            "ItemRevision": null,
            "ReceiptNumber": "62",
            "DocumentType": "Purchase order",
            "SourceDocumentCode": "PO",
            "DocumentNumber": "1000125",
            "DocumentLineNumber": "1",
            "DocumentShipmentLineNumber": "1",
            "PONumber": "1000125",
            "POLineNumber": "1",
            "POScheduleNumber": "1",
            "ASNNumber": "ASN_20230726_154409",
            "IntransitShipmentNumber": null,
            "ShipmentLineNumber": "1",
            "TransferOrderNumber": null,
            "TransferOrderLineNumber": null,
            "RMANumber": null,
            "RMALineNumber": null,
            "TransactionDate": "2023-08-21",
            "VendorName": "Advanced Network Devices",
            "VendorId": 21,
            "VendorSiteCode": "FRESNO",
            "VendorSiteId": 1969,
            "VendorItemNumber": null,
            "CustomerPartyName": null,
            "CustomerId": null,
            "AvailableQuantity": 2,
            "UOMCode": "Ea",
            "UnitOfMeasure": "Each",
            "SecondaryAvailableQuantity": null,
            "SecondaryUOMCode": null,
            "SecondaryUnitOfMeasure": null,
            "DestinationTypeCode": "INVENTORY",
            "POHeaderId": 100000012026081,
            "POLineLocationId": 100000012026086,
            "POLineId": 100000012026085,
            "DistributionCount": 1,
            "ShipmentHeaderId": 3148466,
            "ShipmentLineId": 3227391,
            "TransferOrderHeaderId": null,
            "TransferOrderLineId": null,
            "ReceiptAdviceHeaderId": null,
            "ReceiptAdviceLineId": null,
            "ReceiptSourceCode": "VENDOR",
            "ConsignedItems": "N",
            "BackToBack": "N",
            "ParentTransactionType": "RECEIVE",
            "ParentTransactionId": 3395556,
            "InspectionStatus": "Not inspected",
            "InspectionStatusCode": "NOT INSPECTED",
            "EmployeeName": "Adam, Mrs. Rachel L",
            "EmployeeId": 146,
            "RADocumentCode": null,
            "ItemPrimaryImageURL": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines/3395556",
                    "name": "receivingReceiptPutAwayLines",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines/3395556",
                    "name": "receivingReceiptPutAwayLines",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines",
            "name": "receivingReceiptPutAwayLines",
            "kind": "collection"
        }
    ]
}

Example 2

This example descibes how to get lines to put away 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/receivingReceiptPutAwayLines?q=OrganizationCode=value;TransferOrderNumber=value"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines?q=OrganizationCode=M1;TransferOrderNumber=212008"

Example 2 Response Body

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

{
    "items": [
        {
            "OrganizationId": 207,
            "OrganizationCode": "M1",
            "FromOrganizationCode": "V1",
            "FromOrganizationId": 204,
            "ItemNumber": "AS54888",
            "ItemDescription": "Standard Desktop",
            "ItemId": 149,
            "ItemRevision": null,
            "ReceiptNumber": "33747",
            "DocumentType": "Transfer order",
            "SourceDocumentCode": "TRANSFER ORDER",
            "DocumentNumber": "212008",
            "DocumentLineNumber": "1",
            "DocumentShipmentLineNumber": null,
            "PONumber": null,
            "POLineNumber": null,
            "POScheduleNumber": null,
            "ASNNumber": null,
            "IntransitShipmentNumber": "2352592",
            "ShipmentLineNumber": "1",
            "TransferOrderNumber": "212008",
            "TransferOrderLineNumber": "1",
            "RMANumber": null,
            "RMALineNumber": null,
            "TransactionDate": "2019-09-05",
            "VendorName": null,
            "VendorId": null,
            "VendorSiteCode": null,
            "VendorSiteId": null,
            "VendorItemNumber": null,
            "CustomerPartyName": null,
            "CustomerId": null,
            "AvailableQuantity": 1,
            "UOMCode": "Ea",
            "UnitOfMeasure": "Each",
            "SecondaryAvailableQuantity": null,
            "SecondaryUOMCode": null,
            "SecondaryUnitOfMeasure": null,
            "DestinationTypeCode": "INVENTORY",
            "POHeaderId": null,
            "POLineLocationId": null,
            "POLineId": null,
            "DistributionCount": 0,
            "ShipmentHeaderId": 3034404,
            "ShipmentLineId": 3109257,
            "TransferOrderHeaderId": 212007,
            "TransferOrderLineId": 128006,
            "ReceiptAdviceHeaderId": null,
            "ReceiptAdviceLineId": null,
            "ReceiptSourceCode": "TRANSFER ORDER",
            "ConsignedItems": "N",
            "BackToBack": "N",
            "ParentTransactionType": "RECEIVE",
            "ParentTransactionId": 3238438,
            "InspectionStatus": "Not inspected",
            "InspectionStatusCode": "NOT INSPECTED",
            "EmployeeName": "Brent, Marsha",
            "EmployeeId": 300100036640797,
            "RADocumentCode": null,
            "ItemPrimaryImageURL": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines/3238438",
                    "name": "receivingReceiptPutAwayLines",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines/3238438",
                    "name": "receivingReceiptPutAwayLines",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines",
            "name": "receivingReceiptPutAwayLines",
            "kind": "collection"
        }
    ]
}

Example 3

This example descibes how to get lines to put away 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/receivingReceiptPutAwayLines?q=OrganizationCode=value;ASNNumber=value"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines?q=OrganizationCode=M1;ASNNumber=ASBN1"

Example 3 Response Body

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

{
    "items": [
        {
            "OrganizationId": 207,
            "OrganizationCode": "M1",
            "FromOrganizationCode": null,
            "FromOrganizationId": null,
            "ItemNumber": "RCV-100",
            "ItemDescription": "Plain Item",
            "ItemId": 663907,
            "ItemRevision": null,
            "ReceiptNumber": "69",
            "DocumentType": "Purchase order",
            "SourceDocumentCode": "PO",
            "DocumentNumber": "1000125",
            "DocumentLineNumber": "1",
            "DocumentShipmentLineNumber": "1",
            "PONumber": "1000125",
            "POLineNumber": "1",
            "POScheduleNumber": "1",
            "ASNNumber": "ASBN1",
            "IntransitShipmentNumber": null,
            "ShipmentLineNumber": "1",
            "TransferOrderNumber": null,
            "TransferOrderLineNumber": null,
            "RMANumber": null,
            "RMALineNumber": null,
            "TransactionDate": "2023-08-22",
            "VendorName": "Advanced Network Devices",
            "VendorId": 21,
            "VendorSiteCode": "FRESNO",
            "VendorSiteId": 1969,
            "VendorItemNumber": null,
            "CustomerPartyName": null,
            "CustomerId": null,
            "AvailableQuantity": 2,
            "UOMCode": "Ea",
            "UnitOfMeasure": "Each",
            "SecondaryAvailableQuantity": null,
            "SecondaryUOMCode": null,
            "SecondaryUnitOfMeasure": null,
            "DestinationTypeCode": "INVENTORY",
            "POHeaderId": 100000012026081,
            "POLineLocationId": 100000012026086,
            "POLineId": 100000012026085,
            "DistributionCount": 1,
            "ShipmentHeaderId": 3213471,
            "ShipmentLineId": 3288397,
            "TransferOrderHeaderId": null,
            "TransferOrderLineId": null,
            "ReceiptAdviceHeaderId": null,
            "ReceiptAdviceLineId": null,
            "ReceiptSourceCode": "VENDOR",
            "ConsignedItems": "N",
            "BackToBack": "N",
            "ParentTransactionType": "RECEIVE",
            "ParentTransactionId": 3399552,
            "InspectionStatus": "Not inspected",
            "InspectionStatusCode": "NOT INSPECTED",
            "EmployeeName": "Oliver, Sam",
            "EmployeeId": 300100036644754,
            "RADocumentCode": null,
            "ItemPrimaryImageURL": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines/3399552",
                    "name": "receivingReceiptPutAwayLines",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines/3399552",
                    "name": "receivingReceiptPutAwayLines",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines",
            "name": "receivingReceiptPutAwayLines",
            "kind": "collection"
        }
    ]
}

Example 4

This example descibes how to get lines to put away 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/receivingReceiptPutAwayLines?q=OrganizationCode=value;RMANumber=value"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines?q=OrganizationCode=V1;RMANumber=1265057776"

Example 4 Response Body

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

{
    "items": [
        {
            "OrganizationId": 204,
            "OrganizationCode": "V1",
            "FromOrganizationCode": null,
            "FromOrganizationId": null,
            "ItemNumber": "ASM1000",
            "ItemDescription": "Final Chip High Grade",
            "ItemId": 4658,
            "ItemRevision": null,
            "ReceiptNumber": "8952",
            "DocumentType": "Return material authorization",
            "SourceDocumentCode": "RMA",
            "DocumentNumber": "1265057776",
            "DocumentLineNumber": "1",
            "DocumentShipmentLineNumber": null,
            "PONumber": null,
            "POLineNumber": null,
            "POScheduleNumber": null,
            "ASNNumber": null,
            "IntransitShipmentNumber": null,
            "ShipmentLineNumber": "1",
            "TransferOrderNumber": null,
            "TransferOrderLineNumber": null,
            "RMANumber": "1265057776",
            "RMALineNumber": "1",
            "TransactionDate": "2012-04-23",
            "VendorName": null,
            "VendorId": null,
            "VendorSiteCode": null,
            "VendorSiteId": null,
            "VendorItemNumber": null,
            "CustomerPartyName": "Computer Service and Rentals",
            "CustomerId": 1006,
            "AvailableQuantity": 1,
            "UOMCode": "Ea",
            "UnitOfMeasure": "Each",
            "SecondaryAvailableQuantity": null,
            "SecondaryUOMCode": null,
            "SecondaryUnitOfMeasure": null,
            "DestinationTypeCode": "RECEIVING",
            "POHeaderId": null,
            "POLineLocationId": null,
            "POLineId": null,
            "DistributionCount": 0,
            "ShipmentHeaderId": 2771317,
            "ShipmentLineId": 2848989,
            "TransferOrderHeaderId": null,
            "TransferOrderLineId": null,
            "ReceiptAdviceHeaderId": 2717284,
            "ReceiptAdviceLineId": 2797944,
            "ReceiptSourceCode": "CUSTOMER",
            "ConsignedItems": "N",
            "BackToBack": "N",
            "ParentTransactionType": "RECEIVE",
            "ParentTransactionId": 3008351,
            "InspectionStatus": "Not inspected",
            "InspectionStatusCode": "NOT INSPECTED",
            "EmployeeName": "Andrew Brown",
            "EmployeeId": 100010024203202,
            "RADocumentCode": "RMA",
            "ItemPrimaryImageURL": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines/3008351",
                    "name": "receivingReceiptPutAwayLines",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines/3008351",
                    "name": "receivingReceiptPutAwayLines",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines",
            "name": "receivingReceiptPutAwayLines",
            "kind": "collection"
        }
    ]
}

Example 5

This example descibes how to get lines to put away 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/receivingReceiptPutAwayLines?q=OrganizationCode=value;IntransitShipmentNumber=value"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines?q=OrganizationCode=RCVORG1;IntransitShipmentNumber=DIS1"

Example 5 Response Body

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

{
    "items": [
        {
            "OrganizationId": 300100583436244,
            "OrganizationCode": "RCVORG1",
            "FromOrganizationCode": "M1",
            "FromOrganizationId": 207,
            "ItemNumber": "RCV-100",
            "ItemDescription": "Plain Item",
            "ItemId": 663907,
            "ItemRevision": null,
            "ReceiptNumber": "2",
            "DocumentType": "In-transit shipment",
            "SourceDocumentCode": "INVENTORY",
            "DocumentNumber": "DIS1",
            "DocumentLineNumber": "1",
            "DocumentShipmentLineNumber": null,
            "PONumber": null,
            "POLineNumber": null,
            "POScheduleNumber": null,
            "ASNNumber": null,
            "IntransitShipmentNumber": "DIS1",
            "ShipmentLineNumber": "1",
            "TransferOrderNumber": null,
            "TransferOrderLineNumber": null,
            "RMANumber": null,
            "RMALineNumber": null,
            "TransactionDate": "2023-08-21",
            "VendorName": null,
            "VendorId": null,
            "VendorSiteCode": null,
            "VendorSiteId": null,
            "VendorItemNumber": null,
            "CustomerPartyName": null,
            "CustomerId": null,
            "AvailableQuantity": 10,
            "UOMCode": "Ea",
            "UnitOfMeasure": "Each",
            "SecondaryAvailableQuantity": null,
            "SecondaryUOMCode": null,
            "SecondaryUnitOfMeasure": null,
            "DestinationTypeCode": "INVENTORY",
            "POHeaderId": null,
            "POLineLocationId": null,
            "POLineId": null,
            "DistributionCount": 0,
            "ShipmentHeaderId": 3211466,
            "ShipmentLineId": 3287391,
            "TransferOrderHeaderId": null,
            "TransferOrderLineId": null,
            "ReceiptAdviceHeaderId": null,
            "ReceiptAdviceLineId": null,
            "ReceiptSourceCode": "INVENTORY",
            "ConsignedItems": "N",
            "BackToBack": "N",
            "ParentTransactionType": "RECEIVE",
            "ParentTransactionId": 3396548,
            "InspectionStatus": "Not inspected",
            "InspectionStatusCode": "NOT INSPECTED",
            "EmployeeName": "Brent, Marsha",
            "EmployeeId": 300100036640797,
            "RADocumentCode": null,
            "ItemPrimaryImageURL": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines/3396548",
                    "name": "receivingReceiptPutAwayLines",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines/3396548",
                    "name": "receivingReceiptPutAwayLines",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines",
            "name": "receivingReceiptPutAwayLines",
            "kind": "collection"
        }
    ]
}

Example 6

This example descibes how to get lines to put away using a receipt number.

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/receivingReceiptPutAwayLines?q=OrganizationCode=value;ReceiptNumber=value"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines?q=OrganizationCode=M1;ReceiptNumber=33658"

Example 6 Response Body

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

{
    "items": [
        {
            "OrganizationId": 207,
            "OrganizationCode": "M1",
            "FromOrganizationCode": null,
            "FromOrganizationId": null,
            "ItemNumber": "AS54888",
            "ItemDescription": "Standard Desktop",
            "ItemId": 149,
            "ItemRevision": null,
            "ReceiptNumber": "33658",
            "DocumentType": "Purchase order",
            "SourceDocumentCode": "PO",
            "DocumentNumber": "1002718",
            "DocumentLineNumber": "2",
            "DocumentShipmentLineNumber": "1",
            "PONumber": "1002718",
            "POLineNumber": "2",
            "POScheduleNumber": "1",
            "ASNNumber": null,
            "IntransitShipmentNumber": null,
            "ShipmentLineNumber": "1",
            "TransferOrderNumber": null,
            "TransferOrderLineNumber": null,
            "RMANumber": null,
            "RMALineNumber": null,
            "TransactionDate": "2014-07-30",
            "VendorName": "Advanced Network Devices",
            "VendorId": 21,
            "VendorSiteCode": "FRESNO",
            "VendorSiteId": 1969,
            "VendorItemNumber": null,
            "CustomerPartyName": null,
            "CustomerId": null,
            "AvailableQuantity": 20,
            "UOMCode": "Ea",
            "UnitOfMeasure": "Each",
            "SecondaryAvailableQuantity": null,
            "SecondaryUOMCode": null,
            "SecondaryUnitOfMeasure": null,
            "DestinationTypeCode": "INVENTORY",
            "POHeaderId": 424677,
            "POLineLocationId": 366991,
            "POLineId": 383258,
            "DistributionCount": 1,
            "ShipmentHeaderId": 2797400,
            "ShipmentLineId": 2880264,
            "TransferOrderHeaderId": null,
            "TransferOrderLineId": null,
            "ReceiptAdviceHeaderId": null,
            "ReceiptAdviceLineId": null,
            "ReceiptSourceCode": "VENDOR",
            "ConsignedItems": "N",
            "BackToBack": "N",
            "ParentTransactionType": "RECEIVE",
            "ParentTransactionId": 3035413,
            "InspectionStatus": "Not inspected",
            "InspectionStatusCode": "NOT INSPECTED",
            "EmployeeName": "Oliver, Sam",
            "EmployeeId": 300100036644754,
            "RADocumentCode": null,
            "ItemPrimaryImageURL": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines/3035413",
                    "name": "receivingReceiptPutAwayLines",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines/3035413",
                    "name": "receivingReceiptPutAwayLines",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines",
            "name": "receivingReceiptPutAwayLines",
            "kind": "collection"
        }
    ]
}

Example 7

This example descibes how to get lines to put away using a transaction 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/receivingReceiptPutAwayLines?q=OrganizationCode=value;IntransitShipmentNumber=value;TransactionDate=value"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines?q=OrganizationCode=RCVORG1;IntransitShipmentNumber=DIS1;TransactionDate>=2023-08-21"

Example 7 Response Body

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

{
    "items": [
        {
            "OrganizationId": 300100583436244,
            "OrganizationCode": "RCVORG1",
            "FromOrganizationCode": "M1",
            "FromOrganizationId": 207,
            "ItemNumber": "RCV-100",
            "ItemDescription": "Plain Item",
            "ItemId": 663907,
            "ItemRevision": null,
            "ReceiptNumber": "2",
            "DocumentType": "In-transit shipment",
            "SourceDocumentCode": "INVENTORY",
            "DocumentNumber": "DIS1",
            "DocumentLineNumber": "1",
            "DocumentShipmentLineNumber": null,
            "PONumber": null,
            "POLineNumber": null,
            "POScheduleNumber": null,
            "ASNNumber": null,
            "IntransitShipmentNumber": "DIS1",
            "ShipmentLineNumber": "1",
            "TransferOrderNumber": null,
            "TransferOrderLineNumber": null,
            "RMANumber": null,
            "RMALineNumber": null,
            "TransactionDate": "2023-08-21",
            "VendorName": null,
            "VendorId": null,
            "VendorSiteCode": null,
            "VendorSiteId": null,
            "VendorItemNumber": null,
            "CustomerPartyName": null,
            "CustomerId": null,
            "AvailableQuantity": 10,
            "UOMCode": "Ea",
            "UnitOfMeasure": "Each",
            "SecondaryAvailableQuantity": null,
            "SecondaryUOMCode": null,
            "SecondaryUnitOfMeasure": null,
            "DestinationTypeCode": "INVENTORY",
            "POHeaderId": null,
            "POLineLocationId": null,
            "POLineId": null,
            "DistributionCount": 0,
            "ShipmentHeaderId": 3211466,
            "ShipmentLineId": 3287391,
            "TransferOrderHeaderId": null,
            "TransferOrderLineId": null,
            "ReceiptAdviceHeaderId": null,
            "ReceiptAdviceLineId": null,
            "ReceiptSourceCode": "INVENTORY",
            "ConsignedItems": "N",
            "BackToBack": "N",
            "ParentTransactionType": "RECEIVE",
            "ParentTransactionId": 3396548,
            "InspectionStatus": "Not inspected",
            "InspectionStatusCode": "NOT INSPECTED",
            "EmployeeName": "Brent, Marsha",
            "EmployeeId": 300100036640797,
            "RADocumentCode": null,
            "ItemPrimaryImageURL": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines/3396548",
                    "name": "receivingReceiptPutAwayLines",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines/3396548",
                    "name": "receivingReceiptPutAwayLines",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptPutAwayLines",
            "name": "receivingReceiptPutAwayLines",
            "kind": "collection"
        }
    ]
}

Back to Top