Get one shipment line

get

/fscmRestApi/resources/11.13.18.05/inboundShipments/{inboundShipmentsUniqID}/child/shipmentLines/{shipmentLinesUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Inbound Shipments resource and used to uniquely identify an instance of Inbound Shipments. The client should not generate the hash key value. Instead, the client should query on the Inbound Shipments collection resource in order to navigate to a specific instance of Inbound Shipments to get the hash key.
  • This is the hash key of the attributes which make up the composite key for the Shipment Lines resource and used to uniquely identify an instance of Shipment Lines. The client should not generate the hash key value. Instead, the client should query on the Shipment Lines collection resource in order to navigate to a specific instance of Shipment Lines to get the hash key.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : inboundShipments-shipmentLines-item-response
Type: object
Show Source
  • Read Only: true
    Value that uniquely identifies the license plate number used for this advanced shipment notice line.
  • Attachments
    Title: Attachments
    The Attachments resource gets the details about the documents that the user attached to the shipment line.
  • Read Only: true
    Maximum Length: 1
    Value that indicates whether the supply source for a reservation is a back-to-back purchase order or a transfer order.
  • Read Only: true
    Maximum Length: 35
    Bar code label for the material on the shipment line.
  • Maximum Length: 4000
    Comments or notes entered for the inbound shipment line.
  • Read Only: true
    Maximum Length: 1
    Value that indicates whether the shipment line is created for consigned material.
  • Read Only: true
    Maximum Length: 35
    Reference number assigned to the freight container, used for documentation purposes.
  • Read Only: true
    Name of the country from which goods are exported.
  • Read Only: true
    Maximum Length: 2
    Abbreviation that identifies the country from which goods are exported.
  • Read Only: true
    Maximum Length: 64
    User who created the inbound shipment line record.
  • Read Only: true
    Date and time when the inbound shipment line record was created.
  • Read Only: true
    Maximum Length: 80
    The destination type of the receiving transaction. A list of valid destination type codes is defined using the lookup RCV_DESTINATION_TYPE.
  • Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the destination type of the receiving transaction. A list of valid destination type codes is defined using the lookup RCV_DESTINATION_TYPE.
  • Maximum Length: 30
    Abbreviation that identifies the free on-board terms for an ASN line item. A list of accepted values is defined in the lookup FOB.
  • Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the originating organization of the in-transit shipment or transfer order shipment.
  • Read Only: true
    Value that uniquely identifies the originating organization of the in-transit shipment or transfer order shipment.
  • Read Only: true
    Maximum Length: 255
    Name of the hazard class that's used to identify and classify hazardous materials to comply with safety regulations.
  • Read Only: true
    Value that uniquely identifies the hazard class.
  • Read Only: true
    Maximum Length: 80
    Status that indicates whether the shipment line is interfaced to the external system for third-party logistics scenarios. Values include READY, INTERFACED, and CONFIRMED.
  • Read Only: true
    Value that uniquely identifies the staged receiving transaction interface that created this inbound shipment line.
  • Read Only: true
    Value that uniquely identifies the inventory transaction that creates the inbound shipment in receiving.
  • Flexfields for Inventory Striping Attributes
    Title: Flexfields for Inventory Striping Attributes
    The Flexfields for Inventory Striping Attributes resource manages the inventory striping attributes that the descriptive flexfield references associated with a inbound shipment line. Inventory striping (inventory tracking) attributes are a set of named attributes (project, task, and country of origin) as well as user-configurable attributes, which when specified as part of the receipt or receiving transaction, are used to track the inventory on hand.
  • Read Only: true
    Maximum Length: 240
    Description of the item being shipped.
  • Read Only: true
    Value that uniquely identifies an item.
  • Read Only: true
    Maximum Length: 300
    Number that identifies an item.
  • Read Only: true
    Maximum Length: 18
    Value that identifies an incremental change to the item.
  • Read Only: true
    Date and time when the user most recently updated the inbound shipment line record.
  • Read Only: true
    Maximum Length: 64
    Login of the user who updated the inbound shipment line record.
  • Read Only: true
    Line number of the inbound shipment line for this shipment.
  • Links
  • Read Only: true
    Maximum Length: 255
    Physical area in the subinventory, such as a row, aisle, bin, or shelf, where you store material.
  • Read Only: true
    Value that uniquely identifies the locator.
  • Lots
    Title: Lots
    The Lots resource gets the lot information for a specific inbound shipment line.
  • Read Only: true
    Number of lots in a shipment line. This attribute is intended for integration.
  • Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the receiving organization.
  • Read Only: true
    Value that uniquely identifies the receiving organization.
  • Read Only: true
    Value that uniquely identifies the original transfer order inventory shipment transaction for this return transfer order shipment.
  • Maximum Length: 25
    Document that itemizes the contents of a package, carton, pallet, or container for shipment to a customer.
  • Packing Units
    Title: Packing Units
    The Packing Units resource gets the packing unit hierarchy for a specific inbound shipment line. Each row in the result displays the packing unit and the parent packing unit.
  • Read Only: true
    Value that uniquely identifies the purchase order header.
  • Read Only: true
    Value that uniquely identifies the purchase order line.
  • Read Only: true
    Value that uniquely identifies the purchase order schedule.
  • Title: Line
    Read Only: true
    Number that identifies the purchase order line corresponding to the advance shipment notice or advance shipment billing notice line.
  • Title: Order
    Read Only: true
    Maximum Length: 30
    Number that identifies the purchase order corresponding to the advance shipment notice or advance shipment billing notice line.
  • Title: Schedule
    Read Only: true
    Number that identifies the purchase order schedule corresponding to the advance shipment notice or advance shipment billing notice line.
  • Read Only: true
    Shipped quantity in the primary unit of measure of the item.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Primary unit of measure of the item.
  • Maximum Length: 3
    Abbreviation that identifies the primary unit of measure of the item.
  • Read Only: true
    Net quantity accepted for this inbound shipment line.
  • Read Only: true
    Net quantity received for the inbound shipment line.
  • Read Only: true
    Net quantity rejected for this inbound shipment line.
  • Read Only: true
    Net quantity returned for this inbound shipment line.
  • Read Only: true
    Total quantity of goods shipped for this inbound shipment line.
  • Maximum Length: 30
    Name of the inventory transaction reason.
  • Value that uniquely identifies the inventory transaction reason.
  • Maximum Length: 80
    Routing name for the type of transaction entry that determines the steps that receive the item. Values include Direct delivery, Inspection required, and Standard receipt. A list of valid routing header identifiers is defined using the lookup RCV_ROUTING_HEADERS.
  • Value that uniquely identifies the receipt routing. Values include 1, 2, and 3. A list of valid routing header identifiers is defined using the lookup RCV_ROUTING_HEADERS.
  • Read Only: true
    Net quantity received for the inbound shipment line in the secondary unit of measure for the item.
  • Read Only: true
    Total quantity of goods shipped for this inbound shipment line in the secondary unit of measure for the item.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Name of the secondary unit of measure of the item that belongs to the current shipment line.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the secondary unit of measure of the item in the inbound shipment line.
  • Serials
    Title: Serials
    The Serials resource gets the serial numbers shipped for a specific inbound shipment line. Applies when only the serial controls the shipped item and is not lot controlled.
  • Read Only: true
    Number of serials in a shipment line. This attribute is intended for integration.
  • Read Only: true
    Value that uniquely identifies the inbound shipment header.
  • Flexfields for Shipment Lines
    Title: Flexfields for Shipment Lines
    The Flexfields for Shipment Lines resource gets the descriptive flexfields for the information corresponding to the inbound shipment line. It includes global segments, context, and context sensitive segments.
  • Read Only: true
    Value that uniquely identifies the inbound shipment line.
  • Read Only: true
    Maximum Length: 80
    Name of the state of the inbound shipment line.
  • Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the state of the inbound shipment line. Valid include EXPECTED, PARTIALLY RECEIVED, FULLY RECEIVED, and CANCELLED.
  • Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the document classification based on the originating source such as purchase order or transfer order. A list of valid source document codes is defined using the lookup RCV_SOURCE_DOCUMENT_TYPE.
  • Read Only: true
    Maximum Length: 30
    Value that identifies the originating packing unit for the item.
  • Read Only: true
    Maximum Length: 10
    Subdivision of an organization, representing either a physical area or a local grouping of items, such as a storeroom or receiving dock.
  • Title: Supplier Item
    Read Only: true
    Maximum Length: 300
    Number that the supplier uses to identify the item on the purchase order line.
  • Read Only: true
    Cost of transferring shipments between organizations.
  • Read Only: true
    Value that uniquely identifies the transfer order header associated with the transfer order shipment line.
  • Read Only: true
    Value that uniquely identifies the transfer order line associated with the transfer order shipment line.
  • Title: Transfer Order Line
    Read Only: true
    Number that identifies the transfer order line corresponding to the inbound shipment line.
  • Title: Transfer Order
    Read Only: true
    Maximum Length: 50
    Number that identifies the transfer order corresponding to the inbound shipment line.
  • Read Only: true
    Cost of transportation for the goods.
  • Read Only: true
    Maximum Length: 35
    Number of the truck used for shipment.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Unit of measure used to quantify the inventory items. It is a physical unit (like kg, dozen, or meter) in which we measure and manage different items.
  • Read Only: true
    Maximum Length: 255
    Number that the United Nations uses to identify hazardous material.
  • Read Only: true
    Value that uniquely identifies the number that the United Nations uses to identify hazardous material.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure in which the item corresponding to the current line is shipped.
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource gets the details about the documents that the user attached to the shipment line.
Show Source
Nested Schema : Flexfields for Inventory Striping Attributes
Type: array
Title: Flexfields for Inventory Striping Attributes
The Flexfields for Inventory Striping Attributes resource manages the inventory striping attributes that the descriptive flexfield references associated with a inbound shipment line. Inventory striping (inventory tracking) attributes are a set of named attributes (project, task, and country of origin) as well as user-configurable attributes, which when specified as part of the receipt or receiving transaction, are used to track the inventory on hand.
Show Source
Nested Schema : Lots
Type: array
Title: Lots
The Lots resource gets the lot information for a specific inbound shipment line.
Show Source
Nested Schema : Packing Units
Type: array
Title: Packing Units
The Packing Units resource gets the packing unit hierarchy for a specific inbound shipment line. Each row in the result displays the packing unit and the parent packing unit.
Show Source
Nested Schema : Serials
Type: array
Title: Serials
The Serials resource gets the serial numbers shipped for a specific inbound shipment line. Applies when only the serial controls the shipped item and is not lot controlled.
Show Source
Nested Schema : Flexfields for Shipment Lines
Type: array
Title: Flexfields for Shipment Lines
The Flexfields for Shipment Lines resource gets the descriptive flexfields for the information corresponding to the inbound shipment line. It includes global segments, context, and context sensitive segments.
Show Source
Nested Schema : inboundShipments-shipmentLines-attachments-item-response
Type: object
Show Source
Nested Schema : inboundShipments-shipmentLines-inventoryStripingDFF-item-response
Type: object
Show Source
Nested Schema : inboundShipments-shipmentLines-lots-item-response
Type: object
Show Source
Nested Schema : Serials for Lots
Type: array
Title: Serials for Lots
The Serials for Lots resource displays the serial numbers shipped for a specific lot. Applies when both the lot and the serial control the shipped item.
Show Source
Nested Schema : inboundShipments-shipmentLines-lots-lotSerials-item-response
Type: object
Show Source
Nested Schema : inboundShipments-shipmentLines-packingUnits-item-response
Type: object
Show Source
Nested Schema : inboundShipments-shipmentLines-serials-item-response
Type: object
Show Source
Nested Schema : inboundShipments-shipmentLines-shipmentLineDFFs-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get one shipment line.

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/inboundShipments/compositeKey/child/shipmentLines/compositeKey"

For example, the following command gets one shipment line:

curl -u username:password "https://servername/fscmRestApi/resources/version/inboundShipments/00040000000EACED0005770800000000002D7651FFFFFFFFFFFFFFFF0000000EACED0005770800000000000000CF/child/shipmentLines/000C0000000EACED0005770800000000002E9AB6000000024561FFFFFFFF0000000EACED0005770800000000000A21630000000EACED0005770800000000000000CF0000000EACED0005770800000000000000CF0000000EACED0005770800005AF31131C0E10000000EACED0005770800005AF31131C0E50000000EACED0005770800005AF31131C0E6FFFFFFFFFFFFFFFFFFFFFFFF?onlyData=true"

Example Response Body

The following shows an example of the response body in JSON format.

{
  "ShipmentLineId" : 3054262,
  "ShipmentHeaderId" : 2979409,
  "LineNumber" : 4,
  "CreatedBy" : "WHSE_MGR_M1",
  "CreationDate" : "2018-06-27T07:35:13+00:00",
  "LastUpdateDate" : "2018-06-27T07:35:13+00:00",
  "LastUpdatedBy" : "WHSE_MGR_M1",
  "QuantityShipped" : 2,
  "QuantityReceived" : 0,
  "QuantityAccepted" : null,
  "QuantityRejected" : null,
  "QuantityReturned" : null,
  "UOMCode" : "Ea",
  "UnitOfMeasure" : "Each",
  "ItemId" : 663907,
  "ItemNumber" : "RCV-100",
  "ItemDescription" : "Plain Item",
  "ItemRevision" : null,
  "OrganizationId" : 207,
  "OrganizationCode" : "M1",
  "SourceDocumentCode" : "PO",
  "POHeaderId" : 100000012026081,
  "POLineId" : 100000012026085,
  "POLineLocationId" : 100000012026086,
  "PONumber" : "1000125",
  "POLineNumber" : 1,
  "POScheduleNumber" : 1,
  "DestinationTypeCode" : "INVENTORY",
  "DestinationType" : "Inventory",
  "ShipmentLineStatusCode" : "EXPECTED",
  "ShipmentLineStatus" : "Expected",
  "SecondaryQuantityShipped" : null,
  "SecondaryQuantityReceived" : null,
  "SecondaryUOMCode" : null,
  "SecondaryUOM" : null,
  "ASNLPNId" : 20365,
  "SourcePackingUnit" : "SPUPlain",
  "TransferOrderHeaderId" : null,
  "TransferOrderLineId" : null,
  "TransferOrderNumber" : null,
  "TransferOrderLineNumber" : null,
  "ConsignmentLine" : "N",
  "InventoryShipmentTransactionId" : null,
  "OriginalTOInvShipTransactionId" : null,
  "PackingSlip" : "PSPl270618",
  "CountryOfOriginCode" : "AE",
  "CountryOfOrigin" : "United Arab Emirates",
  "Subinventory" : null,
  "LocatorId" : null,
  "Locator" : null,
  "ContainerNumber" : "SPUPl270618",
  "TruckNumber" : "VehPl270618",
  "BarCodeLabel" : "BCPl270618",
  "Comments" : "NotePl270618",
  "ReasonId" : null,
  "Reason" : null,
  "RoutingHeaderId" : 1,
  "Routing" : "Standard receipt",
  "TransferCost" : null,
  "TransportationCost" : null,
  "InterfaceTransactionId" : 300100159322711,
  "BackToBackOrder" : "N",
  "FromOrganizationId" : null,
  "FromOrganizationCode" : null,
  "IntegrationStatus" : "Ready to interface"
}
Back to Top