1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. Shipments
  5. Outer Packing Units

Get all units

get

/fscmRestApi/resources/11.13.18.05/shipments/{Shipment}/child/outerPackingUnits

Request

Path Parameters
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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds outer packing units for the packing unit.
      Finder Variables:
      • LPNId; integer; Value that uniquely identifies the parent packing unit or container where you pack the detail line.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ContainerItem; string; Identifies the item for the packing unit.
    • ContainerVolume; number; Volume of material that the packing unit can hold.
    • ContainerVolumeUOM; string; Unit of measure that the container volume uses for the packing unit.
    • ContainerVolumeUOMCode; string; Abbreviation that identifies the unit of measure to use for the container volume for the packing unit.
    • FOB; string; Value that indicates the ownership of the items that are in transit. A list of accepted values is defined in the lookup type FOB.
    • FOBCode; string; Abbreviation that identifies the ownership of the items that are in transit.
    • GrossWeight; number; Weight of the packing unit, including contents.
    • GrossWeightUOM; string; Unit of measure for the gross weight of the packing unit.
    • GrossWeightUOMCode; string; Abbreviation that identifies the unit of measure to use for the gross weight for the packing unit.
    • InventoryItemId; integer; Value that uniquely identifies the inventory item.
    • LPNId; integer; Value that uniquely identifies the container that the shipper uses to pack the item.
    • LicensePlateNumber; string; Value that uniquely identifies the packing unit.
    • MasterSerialNumber; string; Master serial number that identifies the packing unit.
    • ParentLPNId; integer; Value that uniquely identifies the parent packing unit or container.
    • SealNumber; string; Number that identifies the seal on a packing unit, locker, or truck to prove that the container remained closed during transport.
    • TareWeight; number; Weight of the container of the packing unit.
    • TareWeightUOM; string; Unit of measure for the tare weight of the packing unit.
    • TareWeightUOMCode; string; Abbreviation that identifies the unit of measure to use for the tare weight of the packing unit.
    • TrackingNumber; string; Value that uniquely identifies the tracking for the packing unit.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : shipments-outerPackingUnits
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : shipments-outerPackingUnits-item-response
Type: object
Show Source
Nested Schema : Attachments for Packing Units
Type: array
Title: Attachments for Packing Units
The Attachments for Packing Units resource manages details about packing unit attachments.
Show Source
Nested Schema : Inner Packing Units
Type: array
Title: Inner Packing Units
The Inner Packing Units resource manages details about the packing unit that's packed in an outer packing unit.
Show Source
Nested Schema : Packing Unit Costs
Type: array
Title: Packing Unit Costs
The Packing Unit Costs resource manages details about the shipping costs for a packing unit.
Show Source
Nested Schema : Packing Instructions for Packing Units
Type: array
Title: Packing Instructions for Packing Units
The Packing Instructions for Packing Units resource manages details about how to pack a packing unit.
Show Source
Nested Schema : Flexfields for Packing Units
Type: array
Title: Flexfields for Packing Units
The Flexfields for Packing Units resource manages details about packing units.
Show Source
Nested Schema : Shipping Instructions for Packing Units
Type: array
Title: Shipping Instructions for Packing Units
The Shipping Instructions for Packing Units resource manages details about how to ship a packing unit.
Show Source
Nested Schema : Shipment Lines
Type: array
Title: Shipment Lines
The Shipment Lines resource manages details about the packed shipment lines.
Show Source
Nested Schema : shipments-outerPackingUnits-attachments-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-innerPackingUnits-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-packingUnitCosts-item-response
Type: object
Show Source
Nested Schema : Flexfields for Shipping Costs in Packing Units
Type: array
Title: Flexfields for Shipping Costs in Packing Units
The Flexfields for Shipping Costs in Packing Units resource manages details about shipping costs.
Show Source
Nested Schema : shipments-outerPackingUnits-packingUnitCosts-shippingCostsDFF-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-packingUnitPackingInstructions-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-packingUnitsDFF-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-packingUnitShippingInstructions-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-item-response
Type: object
Show Source
Nested Schema : Attachments for Shipment Lines
Type: array
Title: Attachments for Shipment Lines
The Attachments for Shipment Lines resource manages details about shipment line attachments.
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 details of the inventory striping attributes. The inventory striping attributes are a set of named attributes (project, task, and country of origin). This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : Packing Instructions for Shipment Lines
Type: array
Title: Packing Instructions for Shipment Lines
The Packing Instructions for Shipment Lines resource manages details about how to pack an item.
Show Source
Nested Schema : Shipping Instructions for Shipment Lines
Type: array
Title: Shipping Instructions for Shipment Lines
The Shipping Instructions for Shipment Lines resource manages details about how to ship items.
Show Source
Nested Schema : Flexfields for Lot Attributes
Type: array
Title: Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages details about lot attributes for the shipment lines.
Show Source
Nested Schema : Flexfields for Lots
Type: array
Title: Flexfields for Lots
The Flexfields for Lots resource manages details about lots for shipment lines.
Show Source
Nested Schema : Prorated Costs for Shipment Lines
Type: array
Title: Prorated Costs for Shipment Lines
The Prorated Costs for Shipment Lines resource manages details about prorated costs for shipment lines.
Show Source
Nested Schema : Shipment Line Costs
Type: array
Title: Shipment Line Costs
The Shipment Line Costs resource manages details about the shipping costs for an item.
Show Source
Nested Schema : Flexfields for Shipment Lines
Type: array
Title: Flexfields for Shipment Lines
The Flexfields for Shipment Lines resource manages details about shipment lines.
Show Source
Nested Schema : Serials for Shipment Lines
Type: array
Title: Serials for Shipment Lines
The Serials for Shipment Lines resource manages details about serial numbers for items in shipment lines.
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-attachments-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-inventoryStripingDFF-item-response
Type: object
Show Source
  • Title: Context Segment
    Maximum Length: 40
    Descriptive flexfield context name of the inventory striping attributes for shipment lines. This attribute is associated with a feature that requires opt in.
  • Title: Context Segment
    Descriptive flexfield context display value of the inventory striping attributes for shipment lines. This attribute is associated with a feature that requires opt in.
  • Title: Country of Origin
    Maximum Length: 2
    Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in.
  • Title: Country of Origin
    Name of the country of origin. This attribute is associated with a feature that requires opt in.
  • Title: Line
    Value that uniquely identifies the shipment line. This attribute is associated with a feature that requires opt in.
  • Links
  • Title: Project
    Value that uniquely identifies the inventory attribute project. This attribute is associated with a feature that requires opt in.
  • Title: Project
    Number that identifies the inventory attribute project. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Value that uniquely identifies the inventory attribute task. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Number that identifies the inventory attribute task. This attribute is associated with a feature that requires opt in.
Nested Schema : shipments-outerPackingUnits-shipmentLines-linePackingInstructions-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-lineShippingInstructions-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-lotAttributeDFF-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-lotStandardDFF-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-proratedCosts-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-shipmentLineCosts-item-response
Type: object
Show Source
Nested Schema : Flexfields for Shipment Line Costs
Type: array
Title: Flexfields for Shipment Line Costs
The Flexfields for Shipment Line Costs resource manages details about shipment line costs.
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-shipmentLineCosts-shippingCostsDFF-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-shipmentLinesDFF-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-shipmentLineSerials-item-response
Type: object
Show Source
  • Flexfields for Serial Attributes
    Title: Flexfields for Serial Attributes
    The Flexfields for Serial Attributes resource manages details about serial attributes for the serial numbers.
  • Read Only: true
    Value that uniquely identifies the shipment line.
  • Read Only: true
    Maximum Length: 255
    Starting serial number in a range of serial numbers. This attribute is used when the warehouse places the item under serial control.
  • Links
  • Serial Numbers
    Title: Serial Numbers
    The Serial Numbers resource manages details about individual serial numbers for the shipment lines.
  • Flexfields for Serials
    Title: Flexfields for Serials
    The Flexfields for Serials resource manages details about serial numbers.
  • Read Only: true
    Maximum Length: 80
    Serial number assigned to the item by the supplier.
  • Read Only: true
    Maximum Length: 80
    Ending serial number in a range of serial numbers. This attribute is used when the warehouse places the item under serial control.
  • Read Only: true
    Value that uniquely identifies a row in the transaction table for temporary inventory.
  • Value that creates a relationship between the serial number and the shipment line. If the line has shipped, then this attribute identifies the shipment line. If the line has not shipped, then this attribute identifies the transaction for a row in a temporary transaction table that references the serial number.
Nested Schema : Flexfields for Serial Attributes
Type: array
Title: Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages details about serial attributes for the serial numbers.
Show Source
Nested Schema : Serial Numbers
Type: array
Title: Serial Numbers
The Serial Numbers resource manages details about individual serial numbers for the shipment lines.
Show Source
Nested Schema : Flexfields for Serials
Type: array
Title: Flexfields for Serials
The Flexfields for Serials resource manages details about serial numbers.
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-shipmentLineSerials-attributeDFF-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-shipmentLineSerials-serialNumbers-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 serial attributes for the serial numbers.
Show Source
Nested Schema : Flexfields for Serials
Type: array
Title: Flexfields for Serials
The Flexfields for Serials resource manages details about serial numbers.
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-shipmentLineSerials-serialNumbers-attributeDFF-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-shipmentLineSerials-serialNumbers-standardDFF-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-shipmentLineSerials-standardDFF-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all units.

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/shipments/Shipment/child/outerPackingUnits"

Example Response Body

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

{
	"items": [
	{
		"LPNId": 5213,
		"LicensePlateNumber": "5173",
		"TrackingNumber": null,
		"MasterSerialNumber": null,
		"SealNumber": null,
		"InventoryItemId": 100000012320400,
		"ContainerItem": "WSH-Container1",
		"ContainerItemDescription": "Finished Good",
		"ContainerVolume": 10,
		"ContainerVolumeUOMCode": "FT3",
		"ContainerVolumeUOM": "Cubic foot",
		"FOBCode": null,
		"FOB": null,
		"GrossWeight": 151,
		"GrossWeightUOMCode": "Lbs",
		"GrossWeightUOM": "Pounds",
		"TareWeight": 1,
		"TareWeightUOMCode": "Lbs",
		"TareWeightUOM": "Pounds",
		"NetWeight": 150,
		"NetWeightUOMCode": "Lbs",
		"NetWeightUOM": "Pounds",
		"PackingUnitCategoryCode": "BOX",
		"PackingUnitCategory": "Box",
		"UnitHeight": null,
		"UnitLength": null,
		"UnitWidth": null,
		"DimensionUOMCode": "IN",
		"DimensionUOM": "Inch",
		"ParentLPNId": null,
		"ParentPackingUnit": null,
		"OutermostPackingUnitId": 5213,
		"OutermostPackingUnit": "5173",
		"PercentageFilled": 100,
		"VolumeFilled": 9.7,
		"ShipFromLocationId": 20795,
		"ShipToLocationId": 936,
		"CarrierId": null,
		"Carrier": null,
		"CarrierNumber": null,
		"ServiceLevelCode": null,
		"ServiceLevel": null,
		"ModeOfTransportCode": null,
		"ModeOfTransport": null,
		"ShipFromAddress1": "475 Avenue",
		"ShipFromAddress2": null,
		"ShipFromAddress3": null,
		"ShipFromAddress4": null,
		"ShipFromCity": "New York",
		"ShipFromCounty": "New York",
		"ShipFromState": "NY",
		"ShipFromRegion": null,
		"ShipFromCountry": "US",
		"ShipFromPostalCode": "10022",
		"ShipToAddress1": "1156 Street",
		"ShipToAddress2": null,
		"ShipToAddress3": null,
		"ShipToAddress4": null,
		"ShipToCity": "Atlanta",
		"ShipToCounty": "Fulton",
		"ShipToState": "GA",
		"ShipToRegion": null,
		"ShipToCountry": "US",
		"ShipToPostalCode": "30010",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/shipments/2238085/child/outerPackingUnits/5213",
			"name": "outerPackingUnits",
			"kind": "item"
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/shipments/2238085/child/outerPackingUnits/5213",
			"name": "outerPackingUnits",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/shipments/2238085",
			"name": "shipments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/shipments/2238085/child/outerPackingUnits/5213/child/attachments",
			"name": "attachments",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/shipments/2238085/child/outerPackingUnits/5213/child/innerPackingUnits",
			"name": "innerPackingUnits",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/shipments/2238085/child/outerPackingUnits/5213/child/packingUnitCosts",
			"name": "packingUnitCosts",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/shipments/2238085/child/outerPackingUnits/5213/child/packingUnitPackingInstructions",
			"name": "packingUnitPackingInstructions",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/shipments/2238085/child/outerPackingUnits/5213/child/packingUnitShippingInstructions",
			"name": "packingUnitShippingInstructions",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/shipments/2238085/child/outerPackingUnits/5213/child/packingUnitsDFF",
			"name": "packingUnitsDFF",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/shipments/2238085/child/outerPackingUnits/5213/child/shipmentLines",
			"name": "shipmentLines",
			"kind": "collection"
		}
		]
	}
	],
	"count": 1,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/shipments/2238085/child/outerPackingUnits",
		"name": "outerPackingUnits",
		"kind": "collection"
	}
	]
}
Back to Top