Jump to

• Request
• Response
• Examples

Get one line

get

/fscmRestApi/resources/11.13.18.05/linesToInspect/{ParentTransactionId}

Request

Path Parameters

• ParentTransactionId(required): integer(int64)
  Value that uniquely identifies the parent transaction.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 : linesToInspect-item-response

Type: object

Show Source

• ASNLineNumber: integer (int64)
  Read Only: true

  Line number of the advanced shipment notice.
• ASNNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the advanced shipment notice for the shipment from the supplier.
• ASNType: string
  Read Only: true

  Maximum Length: 25

  Abbreviation that identifies the document type that specifies how to use this transaction. This attribute contains one of the following values. ASN: create an advance shipment notice; ASBN: create an advance shipment billing notice; STD: create a receipt.
• AvailableQuantity: number
  Read Only: true

  Quantity that is available to inspect the parent transaction.
• BackToBack: string
  Read Only: true

  Maximum Length: 1

  Contains Y or N. Y: use back-to-back shipping. N: reference a transfer order. Note that the order line for the supply source for the reservation references this purchase order. The default value is N.
• CategoryId: integer (int64)
  Read Only: true

  Value that uniquely identifies the category name.
• CategoryName: string
  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.
• Comments: string
  Read Only: true

  Maximum Length: 4000

  Comments provided with the receiving transaction.
• ConsignedItems: string
  Read Only: true

  Maximum Length: 1

  Contains Y, N, or empty. Y: the item is consigned. N: the item is not consigned. The default value is N.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Abbreviation that identifies the currency, such as USD.
• CurrencyConversionDate: string (date)
  Read Only: true

  Date to use when determining the rates that your deployment uses when calculating the currency conversion.
• CurrencyConversionRate: number
  Read Only: true

  Rate to use when calculating the currency conversion.
• CurrencyConversionType: string
  Read Only: true

  Maximum Length: 30

  Currency conversion type.
• CustomerId: integer (int64)
  Read Only: true

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

  Maximum Length: 360

  Name of the party who purchases the item, typically for a fee.
• DestinationType: string
  Read Only: true

  Maximum Length: 80

  Destination type for the item on the transaction line. This attribute determines the accounting behavior of the transaction line. The RCV_DESTINATION_TYPE lookup defines the values that you can use with this attribute.
• DestinationTypeCode: string
  Read Only: true

  Maximum Length: 25

  Abbreviation that identifies the destination type for the item on the transaction line. This attribute determines the accounting behavior of the transaction line. The RCV_DESTINATION_TYPE lookup defines the values that you can use with this attribute.
• DocumentLineNumber: string
  Read Only: true

  Maximum Length: 30

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

  Maximum Length: 80

  Document number that identifies one of the following: the purchase order number for a purchase order, advance shipment notice, or advance shipment billing notice; the number for the return material authorization for the source document code of type RMA; the in-transit shipment number for the source document code of type INVENTORY; or the transfer order number for the source document code of type TRANSFER ORDER.
• DocumentScheduleNumber: string
  Read Only: true

  Maximum Length: 80

  Schedule number for the document.
• 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: 2000

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

  Maximum Length: 18

  Abbreviation that identifies the name of the organization that is the point of origin of the shipment. This value is empty for purchase orders and advanced shipment notices.
• FromOrganizationId: integer (int64)
  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.
• FromOrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the source organization.
• InspectionStatus: string
  Read Only: true

  Maximum Length: 80

  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: 25

  Abbreviation that identifies the inspection status of the item. The RCV_INSPECTION_STATUS lookup defines the values that you can use with this attribute.
• 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 to receive. This item is any part, material, product, or service that contains unique attributes when compared to other items.
• ItemRevision: string
  Read Only: true

  Maximum Length: 18

  Revision of the item.
• LineStatus: string
  Read Only: true

  Maximum Length: 80

  Current status of the received line, such as received, delivered, or inspected. The RCV_LINE_STATUS lookup defines the values that you can use with this attribute.
• links: array Links
  Title: Links

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

  Maximum Length: 60

  Physical location of the warehouse that receives the item.
• LocationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the receiving location.
• Locator: string
  Read Only: true

  Maximum Length: 4000

  Name of the locator where the item currently resides.
• LocatorId: integer (int64)
  Read Only: true

  Value that uniquely identifies the locator.
• manufacturerParts: array Manufacturer Parts
  Title: Manufacturer Parts

  The Manufacturer Parts resource manages the manufacturer parts associated with a receipt line.
• ParentTransactionId: integer (int64)
  Read Only: true

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

  Maximum Length: 25

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

  Value that uniquely identifies the purchase order header.
• POLineId: integer (int64)
  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.
• PORevisionNumber: integer (int64)
  Read Only: true

  Value that identifies the revision of the purchase order.
• PrimaryUOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the primary unit of measure that the item uses.
• Reason: string
  Read Only: true

  Maximum Length: 30

  Rationale for classifying the transaction.
• ReasonId: integer (int64)
  Read Only: true

  Value that uniquely identifies the transaction reason.
• 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.
• ReceiptException: string
  Read Only: true

  Maximum Length: 1

  Contains Y, N, or empty. Y: the transaction contains an exception. N or empty: no exceptions.
• ReceiptNumber: string
  Read Only: true

  Maximum Length: 30

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

  Maximum Length: 25

  Abbreviation that identifies the source type of the shipment.
• Routing: string
  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.
• RoutingHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the routing header.
• SecondaryAvailableQuantity: number
  Read Only: true

  Quantity that is available to inspect in the secondary unit of measure.
• SecondaryUnitOfMeasure: string
  Read Only: true

  Maximum Length: 25

  Unit of measure for the quantity that the receipt transaction contains.
• SecondaryUOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the secondary unit of measure for the quantity that the receipt transaction contains.
• ShipmentHeaderId: integer (int64)
  Read Only: true

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

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

  Maximum Length: 25

  Document type of the shipment. You can use one of the following values for this attribute: PO, RMA, TRANSFER ORDER, or INVENTORY.
• Subinventory: string
  Read Only: true

  Maximum Length: 10

  Name of the subinventory where the item currently resides.
• ToOrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the name of the ship-to organization of the received line.
• ToOrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the ship-to organization of the received line.
• TOShipmentNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the transfer order shipment.
• TransactionDate: string (date)
  Read Only: true

  Date when the transaction finished.
• TransferOrderDistId: integer (int64)
  Read Only: true

  Value that uniquely identifies the transfer order distribution.
• TransferOrderHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the transfer order header. Each transfer order can request to move an item from one location to another location.
• TransferOrderLineId: integer (int64)
  Read Only: true

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

  Maximum Length: 25

  Unit of measure that the received transaction uses.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure that the received transaction uses.
• VendorId: integer (int64)
  Read Only: true

  Value that uniquely identifies 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

  Abbreviation that identifies the name of the buying organization that conducts business with the supplier.
• VendorSiteId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier site.

{
    "type":"object",
    "properties":{
        "ASNNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the advanced shipment notice for the shipment from the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionStatusCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the 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":true
        },
        "SecondaryUnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure for the quantity that the receipt transaction contains.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POLineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order schedule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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 is available to inspect the parent transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineStatus":{
            "maxLength":80,
            "type":"string",
            "description":"Current status of the received line, such as received, delivered, or inspected. The RCV_LINE_STATUS lookup defines the values that you can use with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency, such as USD.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptSourceCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the source type of the shipment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Locator":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the locator where the item currently resides.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentLineNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Line number for the document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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":true
        },
        "POLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipmentLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipment line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReasonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction reason.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VendorSiteCode":{
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the name of the buying organization that conducts business with the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure that the received transaction uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies 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 is the point of origin of the shipment. This value is empty for purchase orders 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":true
        },
        "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
        },
        "ReceiptException":{
            "maxLength":1,
            "type":"string",
            "description":"Contains Y, N, or empty. Y: the transaction contains an exception. N or empty: no exceptions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure that the received transaction uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ToOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to organization of the received line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VendorSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FromOrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the source organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ASNType":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the document type that specifies how to use this transaction. This attribute contains one of the following values. ASN: create an advance shipment notice; ASBN: create an advance shipment billing notice; STD: create a receipt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDocumentCode":{
            "maxLength":25,
            "type":"string",
            "description":"Document type of the shipment. You can use one of the following values for this attribute: PO, RMA, TRANSFER ORDER, or INVENTORY.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmployeeName":{
            "maxLength":2000,
            "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":true
        },
        "CustomerPartyName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the party who purchases the item, typically for a fee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category name.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FromOrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the name of the organization that is the point of origin of the shipment. This value is empty for purchase orders and advanced shipment notices.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ToOrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the name of the ship-to organization of the received line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VendorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyConversionType":{
            "maxLength":30,
            "type":"string",
            "description":"Currency conversion type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransferOrderDistId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transfer order distribution.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "CurrencyConversionDate":{
            "type":"string",
            "description":"Date to use when determining the rates that your deployment uses when calculating the currency conversion.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationType":{
            "maxLength":80,
            "type":"string",
            "description":"Destination type for the item on the transaction line. This attribute 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":true
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Reason":{
            "maxLength":30,
            "type":"string",
            "description":"Rationale for classifying the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentScheduleNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Schedule number for the document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionStatus":{
            "maxLength":80,
            "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":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryAvailableQuantity":{
            "type":"number",
            "description":"Quantity that is available to inspect in the secondary unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RoutingHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the routing header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BackToBack":{
            "maxLength":1,
            "type":"string",
            "description":"Contains Y or N. Y: use back-to-back shipping. N: reference a transfer order. Note that the order line for the supply source for the reservation references this purchase order. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the secondary unit of measure for the quantity that the receipt transaction contains.",
            "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":18
            },
            "x-queryable":true
        },
        "TransferOrderHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transfer order header. Each transfer order can request to move an item 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 transaction finished.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the primary unit of measure that the item uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationTypeCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the destination type for the item on the transaction line. This attribute 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":true
        },
        "CurrencyConversionRate":{
            "type":"number",
            "description":"Rate to use when calculating the currency conversion.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ASNLineNumber":{
            "type":"integer",
            "description":"Line number of the advanced shipment notice.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Comments":{
            "maxLength":4000,
            "type":"string",
            "description":"Comments provided with the receiving transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receiving location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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":true
        },
        "TOShipmentNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the transfer order shipment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Routing":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsignedItems":{
            "maxLength":1,
            "type":"string",
            "description":"Contains Y, N, or empty. Y: the item is consigned. N: the item is not consigned. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipmentHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipment header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Document number that identifies one of the following: the purchase order number for a 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":true
        },
        "PORevisionNumber":{
            "type":"integer",
            "description":"Value that identifies the revision of the purchase order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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":25,
            "type":"string",
            "description":"Transaction type of the parent transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "manufacturerParts":{
            "title":"Manufacturer Parts",
            "type":"array",
            "description":"The Manufacturer Parts resource manages the manufacturer parts associated with a receipt line.",
            "items":{
                "$ref":"#/components/schemas/linesToInspect-manufacturerParts-item-response"
            }
        },
        "Subinventory":{
            "maxLength":10,
            "type":"string",
            "description":"Name of the subinventory where the item currently resides.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":250,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Location":{
            "maxLength":60,
            "type":"string",
            "description":"Physical location of the warehouse that receives the item.",
            "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 : Manufacturer Parts

Type: array

Title: Manufacturer Parts

The Manufacturer Parts resource manages the manufacturer parts associated with a receipt line.

Show Source

• Array of: object linesToInspect-manufacturerParts-item-response

{
    "title":"Manufacturer Parts",
    "type":"array",
    "description":"The Manufacturer Parts resource manages the manufacturer parts associated with a receipt line.",
    "items":{
        "$ref":"#/components/schemas/linesToInspect-manufacturerParts-item-response"
    }
}

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."
        }
    }
}

Nested Schema : linesToInspect-manufacturerParts-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManufacturerName: string
  Title: Manufacturer

  Read Only: true

  Maximum Length: 700

  Name of the manufacturer.
• ManufacturerPartNumber: string
  Title: Manufacturer Part Number

  Read Only: true

  Maximum Length: 255

  Number issued by the manufacturer that uniquely identifies the individual product.

{
    "type":"object",
    "properties":{
        "ManufacturerPartNumber":{
            "title":"Manufacturer Part Number",
            "maxLength":255,
            "type":"string",
            "description":"Number issued by the manufacturer that uniquely identifies the individual product.",
            "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"
            }
        },
        "ManufacturerName":{
            "title":"Manufacturer",
            "maxLength":700,
            "type":"string",
            "description":"Name of the manufacturer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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"
    }
}

Links

manufacturerParts

Operation: /fscmRestApi/resources/11.13.18.05/linesToInspect/{ParentTransactionId}/child/manufacturerParts

Parameters:

• ParentTransactionId: $request.path.ParentTransactionId

The Manufacturer Parts resource manages the manufacturer parts associated with a receipt line.

Back to Top

Examples

This example describes how to get one line to inspect.

Example cURL Command

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

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

For example, the following command gets one line to inspect for transaction 3215474:

curl -u username:password "https://servername/fscmRestApi/resources/version/linesToInspect?q=ParentTransactionId=3215474"

Example Response Body

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

{
"items": [
  {
"ToOrganizationCode": "M1",
"ToOrganizationId": 207,
"FromOrganizationName": null,
"FromOrganizationCode": null,
"FromOrganizationId": null,
"ItemNumber": "RCV-100",
"ItemDescription": "Plain Item",
"ItemId": 663907,
"ItemRevision": null,
"ReceiptNumber": "33869",
"LineStatus": "Received",
"DocumentType": "Purchase order",
"SourceDocumentCode": "PO",
"DocumentNumber": "1004137",
"DocumentLineNumber": "1",
"DocumentScheduleNumber": "1",
"TransactionDate": "2017-03-13",
"VendorName": "First Network Devices",
"VendorId": 21,
"VendorSiteCode": "FRESNO",
"VendorSiteId": 1969,
"VendorItemNumber": null,
"TOShipmentNumber": null,
"ASNType": "STD",
"ASNNumber": null,
"ASNLineNumber": null,
"CustomerPartyName": null,
"CustomerId": null,
"AvailableQuantity": 1,
"UOMCode": "Ea",
"UnitOfMeasure": "Each",
"SecondaryAvailableQuantity": null,
"SecondaryUOMCode": null,
"SecondaryUnitOfMeasure": null,
"DestinationType": "Receiving",
"DestinationTypeCode": "RECEIVING",
"Location": "M1- Seattle Mfg",
"LocationId": 207,
"Routing": "Inspection required",
"RoutingHeaderId": 2,
"POHeaderId": 300100139063422,
"POLineLocationId": 300100139063425,
"POLineId": 300100139063424,
"PORevisionNumber": 0,
"ShipmentHeaderId": 2985477,
"ShipmentLineId": 3062386,
"TransferOrderHeaderId": null,
"TransferOrderLineId": null,
"TransferOrderDistId": null,
"ReceiptAdviceHeaderId": null,
"ReceiptAdviceLineId": null,
"ReceiptSourceCode": "VENDOR",
"ConsignedItems": "N",
"BackToBack": "N",
"CategoryName": "Miscellaneous_1",
"CategoryId": 1,
"CurrencyCode": "USD",
"CurrencyConversionRate": null,
"CurrencyConversionDate": null,
"CurrencyConversionType": null,
"ParentTransactionType": "RECEIVE",
"ParentTransactionId": 3215474,
"InspectionStatus": "Not inspected",
"InspectionStatusCode": "NOT INSPECTED",
"PrimaryUOMCode": "Ea",
"Reason": null,
"ReasonId": null,
"ReceiptException": null,
"EmployeeName": "Brent, Marsha",
"EmployeeId": 300100036640797,
"Comments": null,
"Subinventory": null,
"Locator": null,
"LocatorId": null,
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
  {
"rel": "self",
"href": "https://servername/logisticsApi/resources/version/linesToInspect",
"name": "linesToInspect",
"kind": "collection"
}
],
}

Back to Top