Get all packing units

get

/fscmRestApi/resources/11.13.18.05/shippingPackingUnitsLOV

Request

Query Parameters
  • 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 the packing unit with the specified primary key.
      Finder Variables
      • PackingUnitId; integer; Value that uniquely identifies the packing unit.
    • findByGroupingAttributes Finds the packing unit that matches the specific criteria for OrganizationIdValue; integer; , shipmentIdValue, ShipFromLocationIdValue; integer; , ShipToLocationIdValue; integer; , OutsourcerPartyIdValue; integer; , GroupByCustomer; string; , SoldToPartyIdValue; integer; , GroupByFOB; string; , FOBCodeValue; string; , GroupByShipMethod; string; , ShipMethodCodeValue; string; , GroupByFreightTerms; string; , FreightTermsCodeValue; string; , and SourceHeaderIdValue; integer; .
      Finder Variables
      • FOBCodeValue; string;
      • FreightTermsCodeValue; string;
      • GroupByCustomer; string;
      • GroupByFOB; string;
      • GroupByFreightTerms; string;
      • GroupByShipMethod; string;
      • OrganizationIdValue; integer;
      • OutsourcerPartyIdValue; integer;
      • ShipFromLocationIdValue; integer;
      • ShipMethodCodeValue; string;
      • ShipToLocationIdValue; integer;
      • ShipmentIdValue; integer;
      • SoldToPartyIdValue; integer;
      • SourceHeaderIdValue; 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.
  • 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:
    • CarrierId; integer; Value that uniquely identifies the carrier.
    • ContainerItem; string; Name of the container item.
    • ContainerItemDescription; string; Description of the container item.
    • ContainerItemId; integer; Value that uniquely identifies the container item.
    • ContainerVolumeUOM; string; Total volume of the packing unit container.
    • ContainerVolumeUOMCode; string; Abbreviation that identifies the unit of measure of the packing unit container volume.
    • ContentVolume; number; Total volume of the packing unit contents.
    • ContentVolumeUOMCode; string; Abbreviation that identifies the unit of measure of the packing unit content volume.
    • FOBCode; string; Abbreviation that identifies the ownership of the items that are in transit. A list of accepted values is defined in the lookup type FOB.
    • FreightTermsCode; string; Abbreviation that identifies the freight terms. A list of accepted values is defined in the lookup type 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.
    • ModeOfTransport; string; Mode of transportation that ships goods. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT.
    • 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.
    • OrganizationId; integer; Value that uniquely identifies the organization of the packing unit.
    • OutsourcerPartyId; integer; Value that uniquely identifies the supplier for Outside Processing (OSP) Processing shipment.
    • PackingUnit; string; Name of the packing unit.
    • PackingUnitId; integer; Value that uniquely identifies the packing unit.
    • ServiceLevel; string; Transportation priority that determines how quickly to transport the item. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS.
    • ShipFromLocationId; integer; Value that uniquely identifies the ship-from location.
    • ShipMethodCode; string; Abbreviation that identifies the transportation method for the shipment.
    • ShipToLocationId; integer; Value that uniquely identifies the ship-to location.
    • ShipmentId; integer; Value that uniquely identifies the shipment.
    • SoldToPartyId; integer; Value that uniquely identifies the sold-to party.
    • SourceHeaderId; integer; Value that uniquely identifies the source order header.
    • SourceTypeId; integer; Value that determines the type of order. A list of accepted values is defined in the lookup type ORA_WSH_ORDER_LINE_TYPE.
    • 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.
  • 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 : shippingPackingUnitsLOV
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : shippingPackingUnitsLOV-item-response
Type: object
Show Source
Back to Top