Get quantities for all packing units
get
/fscmRestApi/resources/11.13.18.05/shippingPackingUnits/{PackingUnitHistoryId}/child/packingUnitQuantities
Request
Path Parameters
-
PackingUnitHistoryId(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=
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 -
finder: string
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 the on hand for items in an LPN according to the primary key.
Finder Variables- CountryOfOriginCode; string; Abbreviation that identifies the country of origin.
- InventoryItemId; integer; Value that uniquely identifies the item.
- LPNId; integer; Value that uniquely identifies the license plate number.
- LotNumber; string; Value that identifies a lot or batch of the item.
- OrganizationId; integer; Value that uniquely identifies the organization.
- ProjectId; integer; Value that uniquely identifies the project.
- Revision; string; Revision; string; of the item.
- TaskId; integer; Value that uniquely identifies the task.
- PrimaryKey Finds the on hand for items in an LPN according to the primary key.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- AvailableToTransact; number; Quantity available to transact for the item in the LPN.
- BusinessUnitId; integer; Value that uniquely identifies the business unit.
- CountryOfOriginCode; string; Abbreviation that identifies the country of origin.
- CountryOfOriginName; string; Name of the country of origin.
- InventoryItemId; integer; Value that uniquely identifies the item.
- ItemNumber; string; Number or name that identifies the item.
- LPNId; integer; Value that uniquely identifies the license plate number.
- LicensePlateNumber; string; Name of the license plate number.
- LocatorId; integer; Value that uniquely identifies the locator.
- LocatorName; string; Name of the locator.
- LotControlCode; number; Value that identifies whether the item is lot-controlled. A list of accepted values is defined in the lookup type EGP_LOT_CONTROL_CODE_TYPE.
- LotGrade; string; Abbreviation that identifies the grade associated with the lot of the item.
- LotNumber; string; Value that identifies the lot or batch of the item.
- ObjectVersionNumber; integer; Number that identifies the object version.
- OnhandSummaryId; integer; Value that uniquely identifies an on hand summary.
- OnhandSummaryKey; string; Value that indicates the on hand summary.
- OrganizationCode; string; Abbreviation that identifies the organization.
- OrganizationId; integer; Value that uniquely identifies the organization.
- OwningEntityId; integer; Value that uniquely identifies the owning party that's financially responsible for consigned inventory.
- OwningEntityName; string; Owning party that's financially responsible for consigned inventory.
- OwningType; string; Abbreviation that identifies the type of owner of the financial liability for consigned inventory.
- OwningTypeName; string; Type of owner of the financial liability for consigned inventory.
- PrimaryUOMCode; string; Abbreviation that identifies the primary unit of measure of the item.
- ProjectId; integer; Value that uniquely identifies the project.
- ProjectNumber; string; Name of the project.
- Quantity; number; Quantity of the content item.
- Revision; string; Revision of the content item.
- RevisionControlCode; number; Abbreviation that identifies the revision control of the item.
- SecondaryUOMCode; string; Name of the secondary unit of measure of the item.
- SecondaryUOMQuantity; number; Quantity of the item in secondary unit of measure of the item.
- SerialNumberControlCode; number; Value that identifies if the item is serial-controlled. A list of accepted values is defined in the lookup type EGP_SERIAL_NUMBER_CONTROL_TYPE.
- StockingUOMCode; string; Abbreviation that identifies the unit of measure in which the item is stocked in a subinventory.
- StockingUOMQuantity; number; Quantity of the item in its stocking unit of measure.
- SubinventoryCode; string; Name of the subinventory.
- TaskId; integer; Value that uniquely identifies the task.
- TaskNumber; string; Name of the task.
-
totalResults: boolean
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
-
Metadata-Context: string
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: string
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:
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.
Root Schema : shippingPackingUnits-packingUnitQuantities
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : shippingPackingUnits-packingUnitQuantities-item-response
Type:
Show Source
object
-
AvailableToTransact: number
Read Only:
true
Quantity available to transact for the item in the LPN. -
BusinessUnitId: integer
(int64)
Read Only:
true
Value that uniquely identifies the business unit. -
CountryOfOriginCode: string
Read Only:
true
Maximum Length:2
Abbreviation that identifies the country of origin. -
CountryOfOriginName: string
Read Only:
true
Maximum Length:80
Name of the country of origin. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Number or name that identifies the item. -
LicensePlateNumber: string
Read Only:
true
Maximum Length:30
Name of the license plate number. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocatorId: integer
(int64)
Read Only:
true
Value that uniquely identifies the locator. -
LocatorName: string
Read Only:
true
Maximum Length:2000
Name of the locator. -
LotControlCode: number
Read Only:
true
Value that identifies whether the item is lot-controlled. A list of accepted values is defined in the lookup type EGP_LOT_CONTROL_CODE_TYPE. -
LotGrade: string
Read Only:
true
Maximum Length:150
Abbreviation that identifies the grade associated with the lot of the item. -
LotNumber: string
Read Only:
true
Maximum Length:80
Value that identifies the lot or batch of the item. -
LPNId: integer
Read Only:
true
Value that uniquely identifies the license plate number. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Number that identifies the object version. -
OnhandSummaryId: integer
(int64)
Read Only:
true
Value that uniquely identifies an on hand summary. -
OnhandSummaryKey: string
Read Only:
true
Maximum Length:1000
Value that indicates the on hand summary. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the organization. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization. -
OwningEntityId: integer
(int64)
Read Only:
true
Value that uniquely identifies the owning party that's financially responsible for consigned inventory. -
OwningEntityName: string
Read Only:
true
Maximum Length:240
Owning party that's financially responsible for consigned inventory. -
OwningType: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the type of owner of the financial liability for consigned inventory. -
OwningTypeName: string
Read Only:
true
Maximum Length:240
Type of owner of the financial liability for consigned inventory. -
PrimaryUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the primary unit of measure of the item. -
ProjectId: integer
(int64)
Read Only:
true
Value that uniquely identifies the project. -
ProjectNumber: string
Read Only:
true
Maximum Length:25
Name of the project. -
Quantity: number
Read Only:
true
Quantity of the content item. -
Revision: string
Read Only:
true
Maximum Length:18
Revision of the content item. -
RevisionControlCode: number
Read Only:
true
Abbreviation that identifies the revision control of the item. -
SecondaryUOMCode: string
Read Only:
true
Maximum Length:3
Name of the secondary unit of measure of the item. -
SecondaryUOMQuantity: number
Read Only:
true
Quantity of the item in secondary unit of measure of the item. -
SerialNumberControlCode: number
Read Only:
true
Value that identifies if the item is serial-controlled. A list of accepted values is defined in the lookup type EGP_SERIAL_NUMBER_CONTROL_TYPE. -
StockingUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure in which the item is stocked in a subinventory. -
StockingUOMQuantity: number
Read Only:
true
Quantity of the item in its stocking unit of measure. -
SubinventoryCode: string
Read Only:
true
Maximum Length:10
Name of the subinventory. -
TaskId: integer
(int64)
Read Only:
true
Value that uniquely identifies the task. -
TaskNumber: string
Read Only:
true
Maximum Length:100
Name of the task.
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.