Get one unit
get
/fscmRestApi/resources/11.13.18.05/shipments/{Shipment}/child/outerPackingUnits/{LPNId}/child/innerPackingUnits/{LPNId2}
Request
Path Parameters
-
LPNId(required): integer(int64)
Value that uniquely identifies the container that the shipper uses to pack the item.
-
LPNId2(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
Shipment(required): string
Name of the material shipment.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : shipments-outerPackingUnits-innerPackingUnits-item-response
Type:
Show Source
object
-
Carrier: string
Read Only:
true
Name of the carrier that transports the shipment. -
CarrierId: integer
(int64)
Value that uniquely identifies the carrier.
-
CarrierNumber: string
Read Only:
true
Number that identifies the carrier that transports the shipment. -
ContainerItem: string
Read Only:
true
Identifies the item for the packing unit. -
ContainerItemDescription: string
Read Only:
true
Description of the item for the packing unit. -
ContainerVolume: number
Volume of material that the packing unit can hold.
-
ContainerVolumeUOM: string
Read Only:
true
Unit of measure that the container volume uses for the packing unit. -
ContainerVolumeUOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure to use for the container volume for the packing unit. -
DimensionUOM: string
Read Only:
true
Unit of measure of the dimensions of the packing unit. -
DimensionUOMCode: string
Read Only:
true
Abbreviation that identifies the unit of measure to use for the dimensions of the packing unit. -
FOB: string
Read Only:
true
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
Maximum Length:
30
Abbreviation that identifies the ownership of the items that are in transit. -
GrossWeight: number
Title:
Gross Weight
Weight of the packing unit, including contents. -
GrossWeightUOM: string
Read Only:
true
Unit of measure for the gross weight of the packing unit. -
GrossWeightUOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure to use for the gross weight for the packing unit. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
LicensePlateNumber: string
Title:
Packing Unit
Maximum Length:30
Value that uniquely identifies the packing unit. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LPNId: integer
(int64)
Value that uniquely identifies the container that the shipper uses to pack the item.
-
MasterSerialNumber: string
Maximum Length:
80
Master serial number that identifies the packing unit. -
ModeOfTransport: string
Read Only:
true
Mode of transportation that ships goods. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. -
ModeOfTransportCode: string
Maximum Length:
30
Abbreviation that identifies the mode of transport for the shipping method. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. -
NetWeight: number
Title:
Net Weight
Weight of the contents of the packing unit. -
NetWeightUOM: string
Read Only:
true
Unit of measure of the net weight of the packing unit. -
NetWeightUOMCode: string
Title:
Weight UOM
Maximum Length:3
Abbreviation that identifies the unit of measure to use for the net weight of the packing unit. -
OutermostPackingUnit: string
Read Only:
true
Number that identifies the outermost packing unit. -
OutermostPackingUnitId: integer
(int64)
Value that uniquely identifies the outermost packing unit.
-
PackingUnitCategory: string
Read Only:
true
Type of packing unit. A list of accepted values is defined in the lookup type INV_CONTAINER_TYPE. -
PackingUnitCategoryCode: string
Read Only:
true
Abbreviation that identifies the type of packing unit. A list of accepted values is defined in the lookup type INV_CONTAINER_TYPE. -
ParentLPNId: integer
(int64)
Value that uniquely identifies the parent packing unit or container.
-
ParentPackingUnit: string
Read Only:
true
Number that identifies the parent packing unit. -
PercentageFilled: integer
(int64)
Percent of the packing unit that is packed.
-
SealNumber: string
Title:
Seal Number
Maximum Length:30
Number that identifies the seal on a packing unit, locker, or truck to prove that the container remained closed during transport. -
ServiceLevel: string
Read Only:
true
Transportation priority that determines how quickly to transport the item. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. -
ServiceLevelCode: string
Maximum Length:
30
Abbreviation that identifies the service level for the shipping method. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. -
ShipFromAddress1: string
Read Only:
true
Maximum Length:240
First line of the ship-from address. -
ShipFromAddress2: string
Read Only:
true
Maximum Length:240
Second line of the ship-from address. -
ShipFromAddress3: string
Read Only:
true
Maximum Length:240
Third line of the ship-from address. -
ShipFromAddress4: string
Read Only:
true
Maximum Length:240
Fourth line of the ship-from address. -
ShipFromCity: string
Read Only:
true
Maximum Length:30
City of the ship-from address. -
ShipFromCountry: string
Read Only:
true
Maximum Length:60
Country of the ship-from address. -
ShipFromCounty: string
Read Only:
true
Maximum Length:120
County of the ship-from address. -
ShipFromLocationId: integer
(int64)
Value that uniquely identifies the ship-from location.
-
ShipFromPostalCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the postal code of the ship-from address. -
ShipFromRegion: string
Read Only:
true
Maximum Length:120
Region of the ship-from address. -
ShipFromState: string
Read Only:
true
Maximum Length:120
State of the ship-from address. -
ShipToAddress1: string
Read Only:
true
Maximum Length:240
First line of the ship-to customer address. -
ShipToAddress2: string
Read Only:
true
Maximum Length:240
Second line of ship-to customer address. -
ShipToAddress3: string
Read Only:
true
Maximum Length:240
Third line of the ship-to customer address. -
ShipToAddress4: string
Read Only:
true
Maximum Length:240
Fourth line of the ship-to customer address. -
ShipToCity: string
Read Only:
true
Maximum Length:60
City of the ship-to customer address. -
ShipToCountry: string
Read Only:
true
Maximum Length:60
Country of the ship-to customer address. -
ShipToCounty: string
Read Only:
true
Maximum Length:120
County of the ship-to customer address. -
ShipToLocationId: integer
(int64)
Value that uniquely identifies the ship-to location.
-
ShipToPostalCode: string
Read Only:
true
Maximum Length:60
Abbreviation that identifies the postal code of the ship-to customer address. -
ShipToRegion: string
Read Only:
true
Maximum Length:120
Region of the ship-to customer address. -
ShipToState: string
Read Only:
true
Maximum Length:120
State of the ship-to customer address. -
TareWeight: number
Weight of the container of the packing unit.
-
TareWeightUOM: string
Read Only:
true
Unit of measure for the tare weight of the packing unit. -
TareWeightUOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure to use for the tare weight of the packing unit. -
TrackingNumber: string
Maximum Length:
30
Value that uniquely identifies the tracking for the packing unit. -
UnitHeight: number
Read Only:
true
Height of the packing unit. -
UnitLength: number
Read Only:
true
Length of the packing unit. -
UnitWidth: number
Read Only:
true
Width of the packing unit. -
VolumeFilled: integer
(int64)
Volume of the packing unit that is filled.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.