Jump to

• Request
• Response

Get all packing units

get

/fscmRestApi/resources/11.13.18.05/shippingPackingUnits/{PackingUnitHistoryId}/child/nestedPackingUnits/{PackingUnitHistoryId2}/child/nestedPackingUnits

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=
• PackingUnitHistoryId2(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 packing unit according to the primary key.
    Finder Variables
    • PackingUnitHistoryId; integer; Value that uniquely identifies the packing unit history.
  • findAllLevelsByPackingUnit Finds details of all levels for a specified nested LPN.
    Finder Variables
    • pPackingUnit; string; Value that uniquely identifies the packing unit.
  • findByCycleCount Finds the counted and uncounted packing units in a subinventory or locator for a specified cycle count.
    Finder Variables
    • bindCOO; string; Abbreviation that identifies the country of origin.
    • bindCountedFlag; string; Contains one of the following values true or false. If true, then packing units are counted. If false, then the packing units aren't counted.
    • bindCycleCountHeaderId; integer; Value that uniquely identifies the cycle count.
    • bindItemId; integer; Value that uniquely identifies the item.
    • bindLocatorId; integer; Value that uniquely identifies the inventory locator.
    • bindLotNumber; string; Value that identifies the lot or batch of the item.
    • bindOrgId; integer; Value that uniquely identifies the organization.
    • bindOwningEntityId; integer; Value that uniquely identifies the owning entity. If the item is consigned, this attribute contains the supplier site identifier. If the item is owned, it contains the owning organization identifier.
    • bindProjectId; integer; Value that uniquely identifies the project.
    • bindRevision; string; Revision of the item.
    • bindSubinventory; string; Value that uniquely identifies the subinventory.
    • bindTaskId; integer; Value that uniquely identifies the task.
  • findByPhysicalInventory Finds the counted and uncounted packing units in a subinventory or locator for a specified physical inventory.
    Finder Variables
    • bindCOO; string; Abbreviation that identifies the country of origin.
    • bindCountedFlag; string; Contains one of the following values true or false. If true, then packing units are counted. If false, then the packing units aren't counted.
    • bindItemId; integer; Value that uniquely identifies the item.
    • bindLocatorId; integer; Value that uniquely identifies the inventory locator.
    • bindOrgId; integer; Value that uniquely identifies the organization.
    • bindOwningEntityId; integer; Value that uniquely identifies the owning entity. If the item is consigned, this attribute contains the supplier site identifier. If the item is owned, it contains the owning organization identifier.
    • bindPhysicalInventoryId; integer; Value that uniquely identifies the physical inventory.
    • bindProjectId; integer; Value that uniquely identifies the project.
    • bindRevision; string; Revision of the item.
    • bindSubinventory; string; Value that uniquely identifies the subinventory.
    • bindTaskId; integer; Value that uniquely identifies the task.
  • findByShipmentAndLineAttributes Finds the packing units for the specified shipment and line attributes.
    Finder Variables
    • LineStatusCodeValue; string;
    • ShipmentIdValue; integer; Value that uniquely identifies the shipment.
    • SourceOrderIdValue; integer;
• 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:
  

  • Caller; string; Value that indicates the attachment entity name.
  • ContainerItemDescription; string; Description of the container item.
  • ContainerItemId; integer; Value that uniquely identifies the container item.
  • ContainerItemNumber; string; Name of the container item.
  • ContainerVolume; number; Total volume of the packing unit container.
  • ContainerVolumeUOM; string; Abbreviation that identifies the unit of measure of the LPN container volume.
  • ContainerVolumeUOMName; string; Name of the unit of measure of the packing unit container volume.
  • ContentItemId; number; Value that uniquely identifies the content item.
  • ContentItemImage; string; Value that provides a reference to the content item's image.
  • ContentItemNumber; string; Number or name that identifies the content item.
  • ContentVolume; number; Total volume of the LPN contents.
  • ContentVolumeUOMCode; string; Abbreviation that identifies the unit of measure of the LPN content volume.
  • ContentVolumeUOMName; string; Name of the unit of measure of the packing unit content volume.
  • Country; string; Name of the country of origin.
  • CreationDate; string; Date when the user created the LPN.
  • CurrentCountryOfOriginCode; string; Abbreviation that identifies the country of origin.
  • CurrentProjectId; number; Value that uniquely identifies the project.
  • CurrentTaskId; number; Value that uniquely identifies the task.
  • FOB; string; Free on board that indicates the ownership of items that are in transit. A list of accepted values is defined in the lookup FOB.
  • FOBCode; string; Abbreviation that indicates the ownership of the items that are in transit. A list of accepted values is defined in the lookup FOB.
  • FreightTerms; string; Agreement that describes whether the buyer or seller pays the shipping cost of the sales order, and when payment is due. A list of accepted values is defined in the lookup WSH_FREIGHT_CHARGE_TERMS.
  • FreightTermsCode; string; Abbreviation that identifies the freight terms. A list of accepted values is defined in the lookup WSH_FREIGHT_CHARGE_TERMS.
  • GrossWeight; number; Weight of the packing unit and its contents.
  • GrossWeightUOMCode; string; Abbreviation that identifies the unit of measure of the weight of the packing unit and its contents.
  • GrossWeightUOMName; string; Name of the unit of measure of the weight of the packing unit and its contents.
  • InitialDestination; string; First leg of transportation that the transportation management application planned for delivering the shipment to the final destination.
  • InitialDestinationId; integer; Value that uniquely identifies the first leg of transportation that the transportation management application planned for delivering the shipment to the final destination.
  • LoadId; integer; Value that uniquely identifies the outbound load.
  • LoadName; string; Name of the outbound load.
  • LoadingSequenceType; string; Sequence to use when loading the items into the truck. A list of accepted values is defined in the lookup type WSH_LINES_LOADING_ORDER.
  • LoadingSequenceTypeCode; string; Abbreviation that identifies the rule to be applied on LPNs for loading into the truck. A list of accepted values is defined in the lookup WSH_LINES_LOADING_ORDER.
  • Locator; string; Concatenated name of the inventory locator for the packing unit.
  • LogisticsServiceProviderCustomer; string; Value that uniquely identifies the item locator for the packing unit.
  • ManualWeightVolumeFlag; boolean; Contains one of the following values: true or false. If true, then the weight and volume are manually entered. If false, then the application automatically computed the weight and volume.
  • MasterSerialNumber; string; Serial number that identifies the packing unit.
  • MaximumLoadWeight; number; Maximum weight that can be loaded in a packing unit.
  • MaximumVolume; number; Maximum volume that can be packed in a packing unit.
  • MinimumFillPercentage; number; Minimum percentage of the LPN that's required to be filled.
  • NetWeight; number; Net weight of the packing unit.
  • NetWeightUOMCode; string; Abbreviation that identifies the unit of measure for the net weight of the packing unit.
  • NetWeightUOMName; string; Name of the unit of measure for the net weight of the packing unit.
  • NumberOfShipmentLines; integer; Number of lines packed into the packing unit.
  • OpenExceptionSeverity; string; Number of times the object has been updated.
  • OrderTypeCode; string; Abbreviation that identifies the type of source line.
  • OrganizationCode; string; Abbreviation that identifies the organization of the packing unit.
  • OrganizationCurrencyCode; string; Abbreviation that identifies the currency.
  • OrganizationId; integer; Value that uniquely identifies the organization of the packing unit.
  • OrganizationName; string; Name of the inventory organization.
  • OuterMostPackingUnit; string; Name of the outermost packing unit in which the current packing unit is nested, if the packing unit has a nested structure.
  • OutermostPackingUnitId; integer; Value that uniquely identifies the outermost packing unit in which the current packing unit is nested, if the packing unit has a nested structure.
  • PackingUnit; string; Name of the packing unit.
  • PackingUnitContext; string; Abbreviation that identifies the LPN context.
  • PackingUnitContextMeaning; string; Description of the packing unit context.
  • PackingUnitHistoryId; integer; Value that uniquely identifies the packing unit.
  • PackingUnitId; integer; Name of the parent packing unit.
  • ParentPackingUnit; string; Name of the container item of the parent packing unit.
  • ParentPackingUnitContainer; string; Name of the container item of the parent packing unit.
  • ParentPackingUnitContainerItemId; integer; Value that uniquely identifies the container item of the parent packing unit.
  • ParentPackingUnitId; integer; Value that uniquely identifies the parent packing unit.
  • PercentageFilled; number; Indicates the degree to which the packing unit is packed.
  • PickWave; string; Name of the group of sales orders that the application released into picking.
  • ProjectNumber; string; Name of the project.
  • Revision; string; Revision of the container item.
  • SealCode; string; Abbreviation that identifies the seal of the packing unit.
  • ShipFromLocationId; integer; Value that uniquely identifies the ship-from location.
  • ShipToLocation; string; Value that uniquely identifies the ship-to location.
  • ShipToLocationId; integer; Value that uniquely identifies the ship-to location.
  • Shipment; string; Name of the shipment.
  • ShipmentId; integer; Value that uniquely identifies the shipment.
  • ShipmentStatusCode; string; Abbreviation that identifies the state or condition of the shipment. A list of accepted values is defined in the lookup type WSH_DELIVERY_STATUS.
  • ShippingMethod; string; Value that indicates the method of shipping.
  • ShippingMethodCode; string; Abbreviation that identifies the shipping method.
  • SoldToCustomer; string; Name of the party that purchased the sales order line.
  • SoldToCustomerId; integer; Value that uniquely identifies the sold-to customer.
  • SourceName; string; Name of the source of the packing unit.
  • Subinventory; string; Name of the subinventory.
  • SupplierASN; string; Supplier advanced shipment notice number.
  • TareWeight; number; Tare weight of the packing unit.
  • TareWeightUOMCode; string; Abbreviation that identifies the unit of measure for the tare weight of the packing unit.
  • TareWeightUOMName; string; Name of the unit of measure for the tare weight of the packing unit.
  • TaskNumber; string; Name of the task.
  • TotalShippingCost; number; Total cost associated with shipping the packing unit.
  • TrackingNumber; string; Tracking number of the packing unit.
  • TransportationShipment; string; Value that indicates a shipment planned by the transportation-management application.
  • VolumeFilled; number; Volume of the material packed into the packing unit.
• 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 Top

Response

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.

Body ()

Root Schema : shippingPackingUnits-nestedPackingUnits-nestedPackingUnits

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/shippingPackingUnits-nestedPackingUnits-nestedPackingUnits-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object shippingPackingUnits-nestedPackingUnits-nestedPackingUnits-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/shippingPackingUnits-nestedPackingUnits-nestedPackingUnits-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : shippingPackingUnits-nestedPackingUnits-nestedPackingUnits-item-response

Type: object

Show Source

• AllowAutoGeneration: string
  Default Value: No

  Contains one of the following values: true or false. If true, then the packing unit is generated based on the packing unit setup defined for the organization. If false, then the packing unit is user-defined. There's no default value for this attribute.
• Caller: string
  Read Only: true

  Maximum Length: 255

  Value that indicates the attachment entity name.
• ContainerItemDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the container item.
• ContainerItemId: integer (int64)
  Value that uniquely identifies the container item.
• ContainerItemNumber: string
  Read Only: true

  Maximum Length: 300

  Name of the container item.
• ContainerVolume: number
  Total volume of the packing unit container.
• ContainerVolumeUOM: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure of the LPN container volume.
• ContainerVolumeUOMName: string
  Read Only: true

  Maximum Length: 25

  Name of the unit of measure of the packing unit container volume.
• ContentItemId: number
  Read Only: true

  Value that uniquely identifies the content item.
• ContentItemImage: string
  Read Only: true

  Maximum Length: 4000

  Value that provides a reference to the content item's image.
• ContentItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number or name that identifies the content item.
• ContentVolume: number
  Total volume of the LPN contents.
• ContentVolumeUOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure of the LPN content volume.
• ContentVolumeUOMName: string
  Read Only: true

  Maximum Length: 25

  Name of the unit of measure of the packing unit content volume.
• Country: string
  Read Only: true

  Maximum Length: 80

  Name of the country of origin.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the LPN.
• CurrentCountryOfOriginCode: string
  Read Only: true

  Maximum Length: 2

  Abbreviation that identifies the country of origin.
• CurrentProjectId: number
  Read Only: true

  Value that uniquely identifies the project.
• CurrentTaskId: number
  Read Only: true

  Value that uniquely identifies the task.
• FOB: string
  Read Only: true

  Maximum Length: 80

  Free on board that indicates the ownership of items that are in transit. A list of accepted values is defined in the lookup FOB.
• FOBCode: string
  Maximum Length: 30

  Abbreviation that indicates the ownership of the items that are in transit. A list of accepted values is defined in the lookup FOB.
• FreightTerms: string
  Read Only: true

  Maximum Length: 80

  Agreement that describes whether the buyer or seller pays the shipping cost of the sales order, and when payment is due. A list of accepted values is defined in the lookup WSH_FREIGHT_CHARGE_TERMS.
• FreightTermsCode: string
  Maximum Length: 30

  Abbreviation that identifies the freight terms. A list of accepted values is defined in the lookup WSH_FREIGHT_CHARGE_TERMS.
• GrossWeight: number
  Weight of the packing unit and its contents.
• GrossWeightUOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure of the weight of the packing unit and its contents.
• GrossWeightUOMName: string
  Read Only: true

  Maximum Length: 25

  Name of the unit of measure of the weight of the packing unit and its contents.
• InitialDestination: string
  Read Only: true

  Maximum Length: 255

  First leg of transportation that the transportation management application planned for delivering the shipment to the final destination.
• InitialDestinationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the first leg of transportation that the transportation management application planned for delivering the shipment to the final destination.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoadId: integer (int64)
  Value that uniquely identifies the outbound load.
• LoadingSequenceType: string
  Read Only: true

  Maximum Length: 255

  Sequence to use when loading the items into the truck. A list of accepted values is defined in the lookup type WSH_LINES_LOADING_ORDER.
• LoadingSequenceTypeCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the rule to be applied on LPNs for loading into the truck. A list of accepted values is defined in the lookup WSH_LINES_LOADING_ORDER.
• LoadName: string
  Read Only: true

  Maximum Length: 255

  Name of the outbound load.
• Locator: string
  Read Only: true

  Maximum Length: 255

  Concatenated name of the inventory locator for the packing unit.
• LogisticsServiceProviderCustomer: string
  Read Only: true

  Maximum Length: 360

  Value that uniquely identifies the item locator for the packing unit.
• ManualWeightVolumeFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the weight and volume are manually entered. If false, then the application automatically computed the weight and volume.
• MasterSerialNumber: string
  Maximum Length: 80

  Serial number that identifies the packing unit.
• MaximumLoadWeight: number
  Maximum weight that can be loaded in a packing unit.
• MaximumVolume: number
  Maximum volume that can be packed in a packing unit.
• MinimumFillPercentage: number
  Minimum percentage of the LPN that's required to be filled.
• NetWeight: number
  Net weight of the packing unit.
• NetWeightUOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the net weight of the packing unit.
• NetWeightUOMName: string
  Read Only: true

  Maximum Length: 25

  Name of the unit of measure for the net weight of the packing unit.
• NumberOfShipmentLines: integer (int64)
  Read Only: true

  Number of lines packed into the packing unit.
• OpenExceptionSeverity: string
  Read Only: true

  Maximum Length: 255

  Number of times the object has been updated.
• OpenExceptionSeverityCode: string
  Read Only: true

  Maximum Length: 10

  Value that indicates the highest severity of the exception on the line. A list of accepted values is defined in the lookup type WSH_EXCEPTION_BEHAVIOR.
• OrderType: string
  Read Only: true

  Maximum Length: 255

  Type of source line.
• OrderTypeCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the type of source line.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the organization of the packing unit.
• OrganizationCurrencyCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the currency.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization of the packing unit.
• OrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the inventory organization.
• OuterMostPackingUnit: string
  Read Only: true

  Maximum Length: 30

  Name of the outermost packing unit in which the current packing unit is nested, if the packing unit has a nested structure.
• OutermostPackingUnitId: integer (int64)
  Value that uniquely identifies the outermost packing unit in which the current packing unit is nested, if the packing unit has a nested structure.
• PackingUnit: string
  Read Only: true

  Maximum Length: 30

  Name of the packing unit.
• PackingUnitContext: string
  Maximum Length: 30

  Abbreviation that identifies the LPN context.
• PackingUnitContextMeaning: string
  Read Only: true

  Maximum Length: 80

  Description of the packing unit context.
• PackingUnitHistoryId: integer (int64)
  Value that uniquely identifies the packing unit.
• PackingUnitId: integer (int64)
  Name of the parent packing unit.
• ParentPackingUnit: string
  Read Only: true

  Maximum Length: 30

  Name of the container item of the parent packing unit.
• ParentPackingUnitContainer: string
  Read Only: true

  Maximum Length: 255

  Name of the container item of the parent packing unit.
• ParentPackingUnitContainerItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the container item of the parent packing unit.
• ParentPackingUnitId: integer (int64)
  Value that uniquely identifies the parent packing unit.
• PercentageFilled: number
  Indicates the degree to which the packing unit is packed.
• PickWave: string
  Read Only: true

  Maximum Length: 30

  Name of the group of sales orders that the application released into picking.
• ProjectNumber: string
  Read Only: true

  Maximum Length: 25

  Name of the project.
• Revision: string
  Maximum Length: 18

  Revision of the container item.
• SealCode: string
  Maximum Length: 30

  Abbreviation that identifies the seal of the packing unit.
• ShipFromLocationId: integer (int64)
  Value that uniquely identifies the ship-from location.
• Shipment: string
  Read Only: true

  Maximum Length: 30

  Name of the shipment.
• ShipmentId: integer (int64)
  Value that uniquely identifies the shipment.
• ShipmentStatusCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the state or condition of the shipment. A list of accepted values is defined in the lookup type WSH_DELIVERY_STATUS.
• ShippingMethod: string
  Read Only: true

  Maximum Length: 255

  Value that indicates the method of shipping.
• ShippingMethodCode: string
  Maximum Length: 30

  Abbreviation that identifies the shipping method.
• ShipToLocation: string
  Read Only: true

  Maximum Length: 255

  Value that uniquely identifies the ship-to location.
• ShipToLocationId: integer (int64)
  Value that uniquely identifies the ship-to location.
• SoldToCustomer: string
  Read Only: true

  Maximum Length: 360

  Name of the party that purchased the sales order line.
• SoldToCustomerId: integer (int64)
  Value that uniquely identifies the sold-to customer.
• SourceName: string
  Maximum Length: 30

  Name of the source of the packing unit.
• Subinventory: string
  Maximum Length: 10

  Name of the subinventory.
• SupplierASN: string
  Read Only: true

  Maximum Length: 255

  Supplier advanced shipment notice number.
• TareWeight: number
  Tare weight of the packing unit.
• TareWeightUOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the tare weight of the packing unit.
• TareWeightUOMName: string
  Read Only: true

  Maximum Length: 25

  Name of the unit of measure for the tare weight of the packing unit.
• TaskNumber: string
  Read Only: true

  Maximum Length: 100

  Name of the task.
• TotalShippingCost: number
  Read Only: true

  Total cost associated with shipping the packing unit.
• TrackingNumber: string
  Maximum Length: 30

  Tracking number of the packing unit.
• TransportationShipment: string
  Maximum Length: 101

  Value that indicates a shipment planned by the transportation-management application.
• VolumeFilled: number
  Volume of the material packed into the packing unit.

{
    "type":"object",
    "properties":{
        "ShipmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VolumeFilled":{
            "type":"number",
            "description":"Volume of the material packed into the packing unit.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentVolumeUOMName":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure of the packing unit content volume.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the LPN.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShippingMethod":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the method of shipping.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumFillPercentage":{
            "type":"number",
            "description":"Minimum percentage of the LPN that's required to be filled.",
            "nullable":true,
            "x-queryable":true
        },
        "OpenExceptionSeverityCode":{
            "maxLength":10,
            "type":"string",
            "description":"Value that indicates the highest severity of the exception on the line. A list of accepted values is defined in the lookup type WSH_EXCEPTION_BEHAVIOR.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PackingUnitId":{
            "type":"integer",
            "description":"Name of the parent packing unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentPackingUnit":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the container item of the parent packing unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipmentStatusCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the state or condition of the shipment. A list of accepted values is defined in the lookup type WSH_DELIVERY_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PickWave":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the group of sales orders that the application released into picking.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Locator":{
            "maxLength":255,
            "type":"string",
            "description":"Concatenated name of the inventory locator for the packing unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InitialDestinationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the first leg of transportation that the transportation management application planned for delivering the shipment to the final destination.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "OrderType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of source line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PackingUnitContextMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Description of the packing unit context.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PackingUnitContext":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the LPN context.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumVolume":{
            "type":"number",
            "description":"Maximum volume that can be packed in a packing unit.",
            "nullable":true,
            "x-queryable":true
        },
        "NumberOfShipmentLines":{
            "type":"integer",
            "description":"Number of lines packed into the packing unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "FOB":{
            "maxLength":80,
            "type":"string",
            "description":"Free on board that indicates the ownership of items that are in transit. A list of accepted values is defined in the lookup FOB.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContentItemImage":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that provides a reference to the content item's image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GrossWeightUOMName":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure of the weight of the packing unit and its contents.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParentPackingUnitContainer":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the container item of the parent packing unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TareWeightUOMName":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure for the tare weight of the packing unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManualWeightVolumeFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the weight and volume are manually entered. If false, then the application automatically computed the weight and volume.",
            "nullable":true,
            "x-queryable":true
        },
        "FOBCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates the ownership of the items that are in transit. A list of accepted values is defined in the lookup FOB.",
            "nullable":true,
            "x-queryable":true
        },
        "GrossWeight":{
            "type":"number",
            "description":"Weight of the packing unit and its contents.",
            "nullable":true,
            "x-queryable":true
        },
        "ContainerVolume":{
            "type":"number",
            "description":"Total volume of the packing unit container.",
            "nullable":true,
            "x-queryable":true
        },
        "ContainerVolumeUOM":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure of the LPN container volume.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentVolumeUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure of the LPN content volume.",
            "nullable":true,
            "x-queryable":true
        },
        "Shipment":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the shipment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowAutoGeneration":{
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then the packing unit is generated based on the packing unit setup defined for the organization. If false, then the packing unit is user-defined. There's no default value for this attribute.",
            "nullable":true,
            "default":"No",
            "x-queryable":false
        },
        "MasterSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Serial number that identifies the packing unit.",
            "nullable":true,
            "x-queryable":true
        },
        "ContainerItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the container item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LogisticsServiceProviderCustomer":{
            "maxLength":360,
            "type":"string",
            "description":"Value that uniquely identifies the item locator for the packing unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShippingMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the shipping method.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToLocation":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the ship-to location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GrossWeightUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure of the weight of the packing unit and its contents.",
            "nullable":true,
            "x-queryable":true
        },
        "Revision":{
            "maxLength":18,
            "type":"string",
            "description":"Revision of the container item.",
            "nullable":true,
            "x-queryable":true
        },
        "PackingUnitHistoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the packing unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Country":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the country of origin.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LoadId":{
            "type":"integer",
            "description":"Value that uniquely identifies the outbound load.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentPackingUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent packing unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SoldToCustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sold-to customer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PercentageFilled":{
            "type":"number",
            "description":"Indicates the degree to which the packing unit is packed.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the inventory organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TareWeight":{
            "type":"number",
            "description":"Tare weight of the packing unit.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the type of source line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TrackingNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Tracking number of the packing unit.",
            "nullable":true,
            "x-queryable":true
        },
        "SealCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the seal of the packing unit.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrentTaskId":{
            "type":"number",
            "description":"Value that uniquely identifies the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentCountryOfOriginCode":{
            "maxLength":2,
            "type":"string",
            "description":"Abbreviation that identifies the country of origin.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContentItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number or name that identifies the content item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipFromLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-from location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TareWeightUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the tare weight of the packing unit.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization of the packing unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierASN":{
            "maxLength":255,
            "type":"string",
            "description":"Supplier advanced shipment notice number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SoldToCustomer":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the party that purchased the sales order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OuterMostPackingUnit":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the outermost packing unit in which the current packing unit is nested, if the packing unit has a nested structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LoadingSequenceTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the rule to be applied on LPNs for loading into the truck. A list of accepted values is defined in the lookup WSH_LINES_LOADING_ORDER.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContentItemId":{
            "type":"number",
            "description":"Value that uniquely identifies the content item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContentVolume":{
            "type":"number",
            "description":"Total volume of the LPN contents.",
            "nullable":true,
            "x-queryable":true
        },
        "ContainerItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the container item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NetWeightUOMName":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure for the net weight of the packing unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the organization of the packing unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContainerVolumeUOMName":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure of the packing unit container volume.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContainerItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the container item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InitialDestination":{
            "maxLength":255,
            "type":"string",
            "description":"First leg of transportation that the transportation management application planned for delivering the shipment to the final destination.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentPackingUnitContainerItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the container item of the parent packing unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "TransportationShipment":{
            "maxLength":101,
            "type":"string",
            "description":"Value that indicates a shipment planned by the transportation-management application.",
            "nullable":true,
            "x-queryable":true
        },
        "OpenExceptionSeverity":{
            "maxLength":255,
            "type":"string",
            "description":"Number of times the object has been updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalShippingCost":{
            "type":"number",
            "description":"Total cost associated with shipping the packing unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectNumber":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the project.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NetWeightUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the net weight of the packing unit.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumLoadWeight":{
            "type":"number",
            "description":"Maximum weight that can be loaded in a packing unit.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskNumber":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LoadName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the outbound load.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "LoadId"
                ]
            },
            "x-queryable":true
        },
        "SourceName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the source of the packing unit.",
            "nullable":true,
            "x-queryable":true
        },
        "NetWeight":{
            "type":"number",
            "description":"Net weight of the packing unit.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCurrencyCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OutermostPackingUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the outermost packing unit in which the current packing unit is nested, if the packing unit has a nested structure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrentProjectId":{
            "type":"number",
            "description":"Value that uniquely identifies the project.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Caller":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the attachment entity name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LoadingSequenceType":{
            "maxLength":255,
            "type":"string",
            "description":"Sequence to use when loading the items into the truck. A list of accepted values is defined in the lookup type WSH_LINES_LOADING_ORDER.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Subinventory":{
            "maxLength":10,
            "type":"string",
            "description":"Name of the subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "FreightTermsCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the freight terms. A list of accepted values is defined in the lookup WSH_FREIGHT_CHARGE_TERMS.",
            "nullable":true,
            "x-queryable":true
        },
        "PackingUnit":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the packing unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FreightTerms":{
            "maxLength":80,
            "type":"string",
            "description":"Agreement that describes whether the buyer or seller pays the shipping cost of the sales order, and when payment is due. A list of accepted values is defined in the lookup WSH_FREIGHT_CHARGE_TERMS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top