1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Inventory Management
  4. Inbound Shipments

Get one inbound shipment

get

/fscmRestApi/resources/11.13.18.05/inboundShipments/{inboundShipmentsUniqID}

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.
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-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the document type that specifies how to use this transaction for in-transit shipments and transfer order shipments. This attribute contains one of the following values. ASN: represents an advance shipment notice; ASBN: represents an advance shipment billing notice; STD: represents a transfer order shipment or in-transit shipment.
  • Maximum Length: 25
    Receipt that a carrier issues to the shipper as a contract for carriage of goods. This receipt acknowledges that the cargo is accepted for transportation and must be presented for taking delivery at the destination.
  • Maximum Length: 360
    Name of the company that transports goods from one point to another by land, sea, or air.
  • Maximum Length: 4000
    Comments or notes entered in the inbound shipment header.
  • Maximum Length: 30
    Reference number, used for documentation, assigned to the freight container.
  • Read Only: true
    Maximum Length: 64
    User who created the inbound shipment header record.
  • Read Only: true
    Date and time when the inbound shipment header record was created.
  • Read Only: true
    Maximum Length: 15
    Abbreviation that identifies the invoice amount currency.
  • Date when the inbound shipment is expected to arrive at the receiving organizations.
  • Read Only: true
    Price at which the cargo is delivered from one point to another. The price depends on the mode of transport, the weight of the cargo, and the distance of the delivery destination.
  • Value that uniquely identifies the freight carrier.
  • Maximum Length: 80
    Agreement that describes whether the buyer or seller pays the shipping cost of the sales order, and when payment is due.
  • Maximum Length: 25
    Abbreviation that identifies the freight terms.
  • Read Only: true
    Weight of the fully loaded vehicle, container, or item, including packed items and packaging material.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Unit of measure for the gross weight of the shipment.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure used for gross weight of the shipment.
  • Attachments
    Title: Attachments
    The Attachments resource gets the details about the documents that the user attached to the shipment header.
  • Read Only: true
    Value that uniquely identifies the staged receiving header interface that was used in creating this inbound shipment.
  • Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the integrated system status for an organization.
  • Read Only: true
    Amount on the invoice associated with the shipment or billing notice, such as, an advanced shipment notice with billing information.
  • Read Only: true
    Date when the invoice associated with the shipment or billing notice, such as, an advanced shipment notice with billing information, is due.
  • Read Only: true
    Maximum Length: 50
    Number that identifies the invoice associated with the shipment/billing notice such as, advanced shipment notice with billing information.
  • Read Only: true
    Date and time when the user most recently updated the inbound shipment header record.
  • Read Only: true
    Maximum Length: 64
    Login of the user who updated the inbound shipment header record.
  • Links
  • Maximum Length: 30
    Abbreviation that identifies the mode of transport for the shipping method.
  • Weight of the products being shipped without considering the packaging.
  • Maximum Length: 25
    Unit of measure for the net weight of the shipment.
  • Maximum Length: 3
    Abbreviation that identifies the unit of measure used for net weight of the shipment.
  • Number of packing units in the shipment.
  • Maximum Length: 5
    Abbreviation that identifies the material being transported. The unique packaging code is based on the United Nations Committee of Experts on the Transportation of Dangerous Goods recommendations.
  • Maximum Length: 25
    Document that itemizes the contents of a package, carton, pallet, or container for shipment to a customer.
  • Read Only: true
    Maximum Length: 50
    Name of the payment terms used to schedule payments and to calculate due dates, discount dates, and discount amounts, if applicable.
  • Read Only: true
    Value that uniquely identifies the payment terms.
  • Read Only: true
    Maximum Length: 30
    Number that acknowledges that a shipment was received in the warehouse.
  • Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the source type for the inbound shipment. Values include VENDOR, INVENTORY, and TRANSFER ORDER.
  • Maximum Length: 30
    Transportation priority that determines how quickly to transport goods. A list of accepted values is defined in the lookup WSH_SERVICE_LEVELS.
  • 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: 240
    Name of the originating organization of the in-transit shipment or transfer order shipment.
  • Flexfields for Shipment Headers
    Title: Flexfields for Shipment Headers
    The Flexfields for Shipment Headers resource gets the descriptive flexfields for the information corresponding to the inbound shipment header. It includes global segments, context, and context sensitive segments.
  • Read Only: true
    Value that uniquely identifies the inbound shipment header.
  • Shipment Lines
    Title: Shipment Lines
    The Shipment Lines resource manages details about the shipment lines for a specific shipment header.
  • Read Only: true
    Maximum Length: 30
    Number that identifies the inbound shipment.
  • Maximum Length: 30
    Abbreviation that identifies the transportation method for the shipment.
  • Date when goods were shipped by the supplier.
  • Maximum Length: 255
    The user-visible value that uniquely identifies the carrier shipping method, as a concatenation of carrier name, service level, and mode of transport.
  • Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the organization that receives the item.
  • Read Only: true
    Value that uniquely identifies the receiving organization.
  • Maximum Length: 3
    Abbreviation that identifies the handling instructions for the transported material.
  • Read Only: true
    Maximum Length: 360
    Name of the supplier who provides the products in return for what may or may not require payment.
  • Read Only: true
    Maximum Length: 30
    Number that identifies the supplier.
  • Maximum Length: 30
    Value that's used to identify the shipment in the supplier's source application.
  • Read Only: true
    Maximum Length: 240
    Abbreviation that identifies the supplier site from other sites for a supplier.
  • Weight of an empty vehicle or container. You can subtract the tare weight from the gross weight (laden weight) to find the weight of the carried goods (net weight).
  • Maximum Length: 25
    Unit of measure for the tare weight of the shipment.
  • Maximum Length: 3
    Abbreviation that identifies the unit of measure used for tare weight of the shipment.
  • Read Only: true
    Tax amount associated with the shipment or billing notice name indicated at the header level.
  • Read Only: true
    Maximum Length: 1
    Value that indicates if this inbound shipment can be modified or canceled.
  • Read Only: true
    Value that uniquely identifies the supplier.
  • Read Only: true
    Value that uniquely identifies the supplier site.
  • Maximum Length: 20
    Number that identifies the nonnegotiable document that describes the contract for transporting cargo.
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource gets the details about the documents that the user attached to the shipment header.
Show Source
Nested Schema : Flexfields for Shipment Headers
Type: array
Title: Flexfields for Shipment Headers
The Flexfields for Shipment Headers resource gets the descriptive flexfields for the information corresponding to the inbound shipment header. It includes global segments, context, and context sensitive segments.
Show Source
Nested Schema : Shipment Lines
Type: array
Title: Shipment Lines
The Shipment Lines resource manages details about the shipment lines for a specific shipment header.
Show Source
Nested Schema : inboundShipments-headerAttachments-item-response
Type: object
Show Source
Nested Schema : inboundShipments-shipmentHeaderDFFs-item-response
Type: object
Show Source
Nested 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.
  • 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.
  • 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.
  • Maximum Length: 255
    Name that identifies the free on-board terms for an ASN line item.
  • 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: 255
    Value that indicates the inventory item controls. Values include LOT, SERIAL, and LOTSERIAL.
  • 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.
  • Title: Lot Control
    Read Only: true
    Value that indicates the ability to use lot numbers during material transactions for tracking of batches of items. A list of accepted values is defined in the lookup type EGP_LOT_CONTROL_CODE_TYPE. Review the value for this attribute using the Manage Standard Lookups task in the Setup and Maintenance work area.
  • 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.
  • Title: Manufacturer
    Read Only: true
    Maximum Length: 700
    Name of the manufacturer.
  • Title: Manufacturer Part Number
    Read Only: true
    Maximum Length: 700
    Number issued by the manufacturer that uniquely identifies the individual product.
  • Manufacturer Parts
    Title: Manufacturer Parts
    The Manufacturer Parts resource manages the manufacturer parts associated with a receipt line.
  • Value that indicates if the shipment line has been marked for cancelation. Value values include true and false. Default value is false.
  • Value that indicates if the shipment line has been marked for closure. Value values include true and false. Default value is false.
  • Maximum Length: 1
    Value that indicates if more than one manufacturer part exists for the item in the shipment line. Valid values are Y (multiple parts exist for this item) and N (one manufacturer part or none exist for this item).
  • 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.
  • Title: Serial Number Control
    Read Only: true
    Value that identifies the number assigned to each unit of an item and is used to track the item. A list of accepted values is defined in the lookup EGP_SERIAL_NUMBER_CONTROL_TYPE. Review the value for this attribute using the Manage Standard Lookups task in the Setup and Maintenance work area. The default value is 1.
  • 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
    Maximum Length: 1
    Abbreviation that indicates if the ASN line has been transferred to costing. Valid values are Y, N, and NULL. The default value is NULL.
  • Read Only: true
    Cost of transportation for the goods.
  • 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 : Manufacturer Parts
Type: array
Title: Manufacturer Parts
The Manufacturer Parts resource manages the manufacturer parts associated with a receipt 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 : Flexfields for Lot Attributes
Type: array
Title: Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages details about the lot attributes that the descriptive flexfield references.
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 : Fiexfields for Lots
Type: array
Title: Fiexfields for Lots
The Flexfields for Lots resource manages details about the lot that the descriptive flexfield references.
Show Source
Nested Schema : inboundShipments-shipmentLines-lots-lotAttributeDFF-item-response
Type: object
Show Source
Nested Schema : inboundShipments-shipmentLines-lots-lotSerials-item-response
Type: object
Show Source
Nested Schema : Flexfields for Serial Attributes
Type: array
Title: Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages details about the serial attributes that the descriptive flexfield references.
Show Source
Nested Schema : Flexfields for Serial Numbers
Type: array
Title: Flexfields for Serial Numbers
The Flexfields for Serial Numbers resource manages details about the serial numbers that the descriptive flexfield references.
Show Source
Nested Schema : inboundShipments-shipmentLines-lots-lotSerials-serialAttributeDFF-item-response
Type: object
Show Source
Nested Schema : inboundShipments-shipmentLines-lots-lotSerials-serialStandardDFF-item-response
Type: object
Show Source
Nested Schema : inboundShipments-shipmentLines-lots-lotStandardDFF-item-response
Type: object
Show Source
Nested Schema : inboundShipments-shipmentLines-manufacturerParts-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 : Flexfields for Serial Attributes
Type: array
Title: Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages details about the serial attributes that the descriptive flexfield references.
Show Source
Nested Schema : Flexfields for Serial Numbers
Type: array
Title: Flexfields for Serial Numbers
The Flexfields for Serial Numbers resource manages details about the serial numbers that the descriptive flexfield references.
Show Source
Nested Schema : inboundShipments-shipmentLines-serials-serialAttributeDFF-item-response
Type: object
Show Source
Nested Schema : inboundShipments-shipmentLines-serials-serialStandardDFF-item-response
Type: object
Show Source
Nested Schema : inboundShipments-shipmentLines-shipmentLineDFFs-item-response
Type: object
Show Source
Links
headerAttachments
Parameters:
  • inboundShipmentsUniqID: $request.path.inboundShipmentsUniqID
The Attachments resource gets the details about the documents that the user attached to the shipment header.
shipmentHeaderDFFs
Parameters:
  • inboundShipmentsUniqID: $request.path.inboundShipmentsUniqID
The Flexfields for Shipment Headers resource gets the descriptive flexfields for the information corresponding to the inbound shipment header. It includes global segments, context, and context sensitive segments.
shipmentLines
Parameters:
  • inboundShipmentsUniqID: $request.path.inboundShipmentsUniqID
The Shipment Lines resource manages details about the shipment lines for a specific shipment header.
Back to Top

Examples

This example describes how to get one inbound shipment.

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/compositePrimaryKey"

For example, the following command gets an inbound shipment:

curl -u username:password "https://servername/fscmRestApi/resources/version/inboundShipments/00040000000EACED0005770800000000002D7651FFFFFFFFFFFFFFFF0000000EACED0005770800000000000000C"

Example Response Body

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

{
  "items" : [ {
    "ShipmentHeaderId" : 2979409,
    "CreatedBy" : "WHSE_MGR_M1",
    "CreationDate" : "2018-06-27T07:35:12+00:00",
    "LastUpdateDate" : "2018-06-27T07:35:12+00:00",
    "LastUpdatedBy" : "WHSE_MGR_M1",
    "ReceiptSourceCode" : "VENDOR",
    "ASNType" : "ASN",
    "ShipFromOrganizationId" : null,
    "ShipFromOrganizationCode" : null,
    "ShipmentNumber" : "ASN270618",
    "ReceiptNumber" : null,
    "BillOfLading" : "BOL270618",
    "PackingSlip" : "PS270618",
    "PackagingCode" : "PC270",
    "SpecialHandlingCode" : "SHC",
    "ShippedDate" : "2018-06-27T00:00:00+00:00",
    "FreightCarrierId" : 12528,
    "Carrier" : "J B Hunt",
    "ExpectedReceiptDate" : "2018-06-27T00:00:00+00:00",
    "NumberOfContainers" : 3,
    "WaybillAirbillNumber" : "WB270618",
    "GrossWeight" : null,
    "GrossWeightUOMCode" : null,
    "GrossWeightUOM" : null,
    "NetWeight" : 500,
    "NetWeightUOMCode" : "10P",
    "NetWeightUOM" : "10Pack",
    "TarWeight" : 50,
    "TarWeightUOMCode" : "10P",
    "TarWeightUOM" : "10Pack",
    "FreightTermsCode" : "PPD",
    "FreightTerms" : "PPD",
    "ShipToOrganizationId" : 207,
    "ShipToOrganizationCode" : "M1",
    "IntegratedSystemCode" : null,
    "Comments" : "ASN for demo",
    "VendorId" : 21,
    "SupplierName" : "PennyPack Systems",
    "VendorSiteId" : 1969,
    "SupplierSiteCode" : "FRESNO",
    "InvoiceNumber" : null,
    "InvoiceAmount" : null,
    "InvoiceDate" : null,
    "FreightAmount" : null,
    "TaxAmount" : null,
    "PaymentTermsId" : null,
    "PaymentTerms" : null,
    "CurrencyCode" : null,
    "HeaderInterfaceId" : 300100159322707,
    "shipmentLines" : [ {
      "ShipmentLineId" : 3054259,
      "ShipmentHeaderId" : 2979409,
      "LineNumber" : 1,
      "CreatedBy" : "WHSE_MGR_M1",
      "CreationDate" : "2018-06-27T07:35:12+00:00",
      "LastUpdateDate" : "2018-06-27T07:35:12+00:00",
      "LastUpdatedBy" : "WHSE_MGR_M1",
      "QuantityShipped" : 2,
      "QuantityReceived" : 0,
      "QuantityAccepted" : null,
      "QuantityRejected" : null,
      "QuantityReturned" : null,
      "UOMCode" : "Ea",
      "UnitOfMeasure" : "Each",
      "ItemId" : 663997,
      "ItemNumber" : "VC110",
      "ItemDescription" : "VC-Lot Serial Revision",
      "ItemRevision" : "A",
      "OrganizationId" : 207,
      "OrganizationCode" : "M1",
      "SourceDocumentCode" : "PO",
      "POHeaderId" : 100000012026081,
      "POLineId" : 100000012026218,
      "POLineLocationId" : 100000012026219,
      "PONumber" : "1000125",
      "POLineNumber" : 8,
      "POScheduleNumber" : 1,
      "DestinationTypeCode" : "INVENTORY",
      "DestinationType" : "Inventory",
      "ShipmentLineStatusCode" : "EXPECTED",
      "ShipmentLineStatus" : "Expected",
      "SecondaryQuantityShipped" : null,
      "SecondaryQuantityReceived" : null,
      "SecondaryUOMCode" : null,
      "SecondaryUOM" : null,
      "ASNLPNId" : null,
      "SourcePackingUnit" : null,
      "TransferOrderHeaderId" : null,
      "TransferOrderLineId" : null,
      "TransferOrderNumber" : null,
      "TransferOrderLineNumber" : null,
      "ConsignmentLine" : "N",
      "InventoryShipmentTransactionId" : null,
      "OriginalTOInvShipTransactionId" : null,
      "PackingSlip" : "PSLS270618",
      "CountryOfOriginCode" : "CL",
      "CountryOfOrigin" : "Chile",
      "Subinventory" : null,
      "LocatorId" : null,
      "Locator" : null,
      "ContainerNumber" : "SPULS270618",
      "TruckNumber" : "VehLS270618",
      "BarCodeLabel" : "BCLS270618",
      "Comments" : "NoteLS270618",
      "ReasonId" : null,
      "Reason" : null,
      "RoutingHeaderId" : 1,
      "Routing" : "Standard receipt",
      "TransferCost" : null,
      "TransportationCost" : null,
      "InterfaceTransactionId" : 300100159322708,
      "BackToBackOrder" : "N",
      "FromOrganizationId" : null,
      "FromOrganizationCode" : null,
      "IntegrationStatus" : "Ready to interface",
      "lots" : [ {
        "LotNumber" : "LOT270618_02",
        "ShipmentLineId" : 3054259,
        "Quantity" : 2,
        "UOMCode" : "Ea",
        "SecondaryQuantity" : null,
        "SecondaryUOMCode" : null,
        "TransactionId" : null,
        "SerialTransactionId" : null,
        "LotExpirationDate" : null,
        "lotSerials" : [ {
          "SerialNumber" : "SER270618_03"
        }, {
          "SerialNumber" : "SER270618_04"
        } ]
      } ],
      "packingUnits" : [ ],
      "attachments" : [ ],
      "serials" : [ ],
      "shipmentLineDFFs" : [ {
        "ShipmentLineId" : 3054259,
        "_Global__Segment" : null,
        "_zBIADFF1" : null,
        "_BI_2DGlob_2DRL" : null,
        "restglobalseg1" : null,
        "__FLEX_Context" : null,
        "__FLEX_Context_DisplayValue" : null
      } ]
    }, {
      "ShipmentLineId" : 3054260,
      "ShipmentHeaderId" : 2979409,
      "LineNumber" : 2,
      "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" : 663909,
      "ItemNumber" : "RCV-102",
      "ItemDescription" : "Serial @ Receipt Item",
      "ItemRevision" : null,
      "OrganizationId" : 207,
      "OrganizationCode" : "M1",
      "SourceDocumentCode" : "PO",
      "POHeaderId" : 100000012026081,
      "POLineId" : 100000012026181,
      "POLineLocationId" : 100000012026182,
      "PONumber" : "1000125",
      "POLineNumber" : 3,
      "POScheduleNumber" : 1,
      "DestinationTypeCode" : "INVENTORY",
      "DestinationType" : "Inventory",
      "ShipmentLineStatusCode" : "EXPECTED",
      "ShipmentLineStatus" : "Expected",
      "SecondaryQuantityShipped" : null,
      "SecondaryQuantityReceived" : null,
      "SecondaryUOMCode" : null,
      "SecondaryUOM" : null,
      "ASNLPNId" : null,
      "SourcePackingUnit" : null,
      "TransferOrderHeaderId" : null,
      "TransferOrderLineId" : null,
      "TransferOrderNumber" : null,
      "TransferOrderLineNumber" : null,
      "ConsignmentLine" : "N",
      "InventoryShipmentTransactionId" : null,
      "OriginalTOInvShipTransactionId" : null,
      "PackingSlip" : "PSSer270618",
      "CountryOfOriginCode" : "AL",
      "CountryOfOrigin" : "Albania",
      "Subinventory" : null,
      "LocatorId" : null,
      "Locator" : null,
      "ContainerNumber" : "SPUSer270618",
      "TruckNumber" : "VehSer270618",
      "BarCodeLabel" : "BCSer270618",
      "Comments" : "NoteSer270618",
      "ReasonId" : null,
      "Reason" : null,
      "RoutingHeaderId" : 1,
      "Routing" : "Standard receipt",
      "TransferCost" : null,
      "TransportationCost" : null,
      "InterfaceTransactionId" : 300100159322709,
      "BackToBackOrder" : "N",
      "FromOrganizationId" : null,
      "FromOrganizationCode" : null,
      "IntegrationStatus" : "Ready to interface",
      "lots" : [ ],
      "packingUnits" : [ ],
      "attachments" : [ ],
      "serials" : [ {
        "SerialNumber" : "SER270618_01",
        "ShipmentLineId" : 3054260,
        "TransactionId" : null
      }, {
        "SerialNumber" : "SER270618_02",
        "ShipmentLineId" : 3054260,
        "TransactionId" : null
      } ],
      "shipmentLineDFFs" : [ {
        "ShipmentLineId" : 3054260,
        "_Global__Segment" : null,
        "_zBIADFF1" : null,
        "_BI_2DGlob_2DRL" : null,
        "restglobalseg1" : null,
        "__FLEX_Context" : null,
        "__FLEX_Context_DisplayValue" : null
      } ]
    }, {
      "ShipmentLineId" : 3054261,
      "ShipmentHeaderId" : 2979409,
      "LineNumber" : 3,
      "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" : 663908,
      "ItemNumber" : "RCV-101",
      "ItemDescription" : "Lot Item",
      "ItemRevision" : null,
      "OrganizationId" : 207,
      "OrganizationCode" : "M1",
      "SourceDocumentCode" : "PO",
      "POHeaderId" : 100000012026081,
      "POLineId" : 100000012026104,
      "POLineLocationId" : 100000012026105,
      "PONumber" : "1000125",
      "POLineNumber" : 2,
      "POScheduleNumber" : 1,
      "DestinationTypeCode" : "INVENTORY",
      "DestinationType" : "Inventory",
      "ShipmentLineStatusCode" : "EXPECTED",
      "ShipmentLineStatus" : "Expected",
      "SecondaryQuantityShipped" : null,
      "SecondaryQuantityReceived" : null,
      "SecondaryUOMCode" : null,
      "SecondaryUOM" : null,
      "ASNLPNId" : null,
      "SourcePackingUnit" : null,
      "TransferOrderHeaderId" : null,
      "TransferOrderLineId" : null,
      "TransferOrderNumber" : null,
      "TransferOrderLineNumber" : null,
      "ConsignmentLine" : "N",
      "InventoryShipmentTransactionId" : null,
      "OriginalTOInvShipTransactionId" : null,
      "PackingSlip" : "PSLot270618",
      "CountryOfOriginCode" : "BE",
      "CountryOfOrigin" : "Belgium",
      "Subinventory" : null,
      "LocatorId" : null,
      "Locator" : null,
      "ContainerNumber" : "SPULot270618",
      "TruckNumber" : "VehLot270618",
      "BarCodeLabel" : "BClot270618",
      "Comments" : "NoteLot270618",
      "ReasonId" : null,
      "Reason" : null,
      "RoutingHeaderId" : 1,
      "Routing" : "Standard receipt",
      "TransferCost" : null,
      "TransportationCost" : null,
      "InterfaceTransactionId" : 300100159322710,
      "BackToBackOrder" : "N",
      "FromOrganizationId" : null,
      "FromOrganizationCode" : null,
      "IntegrationStatus" : "Ready to interface",
      "lots" : [ {
        "LotNumber" : "Lot270618_01",
        "ShipmentLineId" : 3054261,
        "Quantity" : 2,
        "UOMCode" : "Ea",
        "SecondaryQuantity" : null,
        "SecondaryUOMCode" : null,
        "TransactionId" : null,
        "SerialTransactionId" : null,
        "LotExpirationDate" : null,
        "lotSerials" : [ ]
      } ],
      "packingUnits" : [ ],
      "attachments" : [ ],
      "serials" : [ ],
      "shipmentLineDFFs" : [ {
        "ShipmentLineId" : 3054261,
        "_Global__Segment" : null,
        "_zBIADFF1" : null,
        "_BI_2DGlob_2DRL" : null,
        "restglobalseg1" : null,
        "__FLEX_Context" : null,
        "__FLEX_Context_DisplayValue" : null
      } ]
    }, {
      "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",
      "lots" : [ ],
      "packingUnits" : [ {
        "RootLPNId" : 20365,
        "LPNId" : 20365,
        "PackingUnit" : "SPUPlain",
        "ParentLPNId" : 20366,
        "ParentPackingUnit" : "SPUPlainP"
      }, {
        "RootLPNId" : 20365,
        "LPNId" : 20366,
        "PackingUnit" : "SPUPlainP",
        "ParentLPNId" : null,
        "ParentPackingUnit" : null
      } ],
      "attachments" : [ {
        "AttachedDocumentId" : 300100159322722,
        "LastUpdateDate" : "2018-06-27T07:35:11.084+00:00",
        "LastUpdatedBy" : "WHSE_MGR_M1",
        "DatatypeCode" : "FILE",
        "FileName" : "ASNLineFileAttach.txt",
        "DmFolderPath" : null,
        "Url" : null,
        "CategoryName" : "MISC",
        "UserName" : "Miscellaneous",
        "Uri" : null,
        "FileUrl" : "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a123664?XFND_SCHEME_ID=1&XFND_CERT_FP;=B48465A4C3EE1F30F61251CF36F4E88326C6C2CD&XFND_RANDOM;=-3328604490614457450&XFND_EXPIRES;=1530090359786&XFND_SIGNATURE;=ER0HGjwvHIUFg0mp7UjvkJt4tHtL5FnWNGk7Ig9rL33HzAC~IlSvTdiEBCXImlcNz80UK4Hgp25WBh-Z5xhnzcOgYy3aROmotYcYhyT54Zettb5Zfw3k8RmScy4CdgyJVMpCU7rQYqzzpJuVDNYiFTkstYGjNhnslvWlNrsIj-DpwNW5k8QLY8bnlf0YeUhdC06-67ISOaHB13oADVXFzt-rLEY8qMl24gZdLyI6CPl32CDk9Vbe4XM3my1Mc1iCEUgmLZnCM~H3KAtj4POGA5U4wfAIZJ~4SSco7BauyGo-24AH7psZsPx-ROw9fS-3D4Q4WF-PPpd8Fne0TZGpeg__&Id;=123664&download;",
        "UploadedText" : null,
        "UploadedFileContentType" : "text/plain",
        "UploadedFileLength" : 26,
        "UploadedFileName" : null,
        "ContentRepositoryFileShared" : "false",
        "Title" : "ASN Line Attach",
        "Description" : "ASN Line Attach",
        "ErrorStatusCode" : null,
        "ErrorStatusMessage" : null,
        "CreatedBy" : "WHSE_MGR_M1",
        "CreationDate" : "2018-06-27T07:25:26.390+00:00",
        "ExpirationDate" : null,
        "LastUpdatedByUserName" : "Sam Jones",
        "CreatedByUserName" : "Sam Jones"
      } ],
      "serials" : [ ],
      "shipmentLineDFFs" : [ {
        "ShipmentLineId" : 3054262,
        "_Global__Segment" : null,
        "_zBIADFF1" : null,
        "_BI_2DGlob_2DRL" : null,
        "restglobalseg1" : null,
        "__FLEX_Context" : null,
        "__FLEX_Context_DisplayValue" : null
      } ]
    } ],
    "shipmentHeaderDFFs" : [ {
      "ShipmentHeaderId" : 2979409,
      "_Global__Segment" : null,
      "_zBIADFF1" : null,
      "_BI_2DGlob_2DRH" : null,
      "restglobalseg1" : null,
      "__FLEX_Context" : null,
      "__FLEX_Context_DisplayValue" : null
    } ]
  } ],
  "count" : 1,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/inboundShipments",
    "name" : "inboundShipments",
    "kind" : "collection"
  } ]
}
Back to Top