Get all lots

get

/fscmRestApi/resources/11.13.18.05/openPickLines/{TransactionId}/child/itemLots

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

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

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

    • PrimaryKey: Finds pick slip item lots according to the primary key.
      Finder Variables:
      • Lot; string; Value that uniquely identifies the lot.
  • 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:
    • Lot; string; Value that uniquely identifies the lot. The lot includes items that you produce together as a group and that share similar production costs and specifications. Applies when the warehouse places the item under lot control.
    • Quantity; number; Quantity picked for the lot number.
    • SecondaryQuantity; number; Quantity picked for the lot number using the secondary unit of measure.
  • 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 : openPickLines-itemLots
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : openPickLines-itemLots-item-response
Type: object
Show Source
Nested Schema : Serial Details for Lots
Type: array
Title: Serial Details for Lots
The Serial Details for Lots resource manages details about the serial when the lot controls the picked item. Use this resource when the lot controls the item.
Show Source
Nested Schema : Flexfields for Lot Attributes
Type: array
Title: Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages descriptive flexfields for the lot attribute.
Show Source
Nested Schema : Flexfields for Lots
Type: array
Title: Flexfields for Lots
The Flexfields for Lots resource manages descriptive flexfields for the lot.
Show Source
Nested Schema : openPickLines-itemLots-itemLotSerials-item-response
Type: object
Show Source
Nested Schema : Flexfields for Serials That Control Items and Lots
Type: array
Title: Flexfields for Serials That Control Items and Lots
The Flexfields for Serials That Control Items and Lots resource manages descriptive flexfields for serial attributes. Use it when a serial controls the item or the lot.
Show Source
Nested Schema : Flexfields for Serials That Control Lots
Type: array
Title: Flexfields for Serials That Control Lots
The Flexfields for Serials That Control Lots resource manages descriptive flexfields for serials. Use it when a serial controls the lot.
Show Source
Nested Schema : openPickLines-itemLots-itemLotSerials-lotSerialAttributeDFFs-item-response
Type: object
Show Source
Nested Schema : openPickLines-itemLots-itemLotSerials-lotSerialStandardDFFs-item-response
Type: object
Show Source
Nested Schema : openPickLines-itemLots-lotAttributeDFFs-item-response
Type: object
Show Source
Nested Schema : openPickLines-itemLots-lotStandardDFFs-item-response
Type: object
Show Source
  • Title: Context Value
    Maximum Length: 30
    Value that uniquely identifies the lot for the transaction.
  • Title: Context Value
    Value that uniquely identifies the lot. The lot includes items that you produce together as a group and that share similar production costs and specifications. Applies when the warehouse places the item under lot control.
  • Links
  • Maximum Length: 80
    Value that uniquely identifies the lot. The lot includes items that you produce together as a group and that share similar production costs and specifications. Applies when the warehouse places the item under lot control.
  • Value that uniquely identifies the lot for the transaction.
Back to Top

Examples

This example describes how to get all lot details for a picked item.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "server:port/fscmRestApi/resources/version/openPickLines/TransactionId/child/itemLots"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/openPickLines/22902186/child/itemLots"

Example Response Body

The following shows an example of the response body in JSON format.
"{
    "items": [
        {
            "Lot": "S135020",
            "Quantity": 5,
            "SecondaryQuantity": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://servername/fscmRestApi/resources/version/openPickLines/22902186/child/itemLots/00020000000EACED0005770800000000015D75AA0000000753313335303230",
                    "name": "itemLots",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "http://servername/fscmRestApi/resources/version/openPickLines/22902186/child/itemLots/00020000000EACED0005770800000000015D75AA0000000753313335303230",
                    "name": "itemLots",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "http://servername/fscmRestApi/resources/version/openPickLines/22902186",
                    "name": "openPickLines",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "http://servername/fscmRestApi/resources/version/openPickLines/22902186/child/itemLots/00020000000EACED0005770800000000015D75AA0000000753313335303230/child/itemLotSerials",
                    "name": "itemLotSerials",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "http://servername/fscmRestApi/resources/version/openPickLines/22902186/child/itemLots/00020000000EACED0005770800000000015D75AA0000000753313335303230/child/lotAttributeDFFs",
                    "name": "lotAttributeDFFs",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "http://servername/fscmRestApi/resources/version/openPickLines/22902186/child/itemLots/00020000000EACED0005770800000000015D75AA0000000753313335303230/child/lotStandardDFFs",
                    "name": "lotStandardDFFs",
                    "kind": "collection"
                }
            ]
        },
        {
            "Lot": "S135021",
            "Quantity": 5,
            "SecondaryQuantity": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://servername/fscmRestApi/resources/version/openPickLines/22902186/child/itemLots/00020000000EACED0005770800000000015D75AA0000000753313335303231",
                    "name": "itemLots",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "http://servername/fscmRestApi/resources/version/openPickLines/22902186/child/itemLots/00020000000EACED0005770800000000015D75AA0000000753313335303231",
                    "name": "itemLots",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "http://servername/fscmRestApi/resources/version/openPickLines/22902186",
                    "name": "openPickLines",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "http://servername/fscmRestApi/resources/version/openPickLines/22902186/child/itemLots/00020000000EACED0005770800000000015D75AA0000000753313335303231/child/itemLotSerials",
                    "name": "itemLotSerials",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "http://servername/fscmRestApi/resources/version/openPickLines/22902186/child/itemLots/00020000000EACED0005770800000000015D75AA0000000753313335303231/child/lotAttributeDFFs",
                    "name": "lotAttributeDFFs",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "http://servername/fscmRestApi/resources/version/openPickLines/22902186/child/itemLots/00020000000EACED0005770800000000015D75AA0000000753313335303231/child/lotStandardDFFs",
                    "name": "lotStandardDFFs",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "http://servername/fscmRestApi/resources/version/openPickLines/22902186/child/itemLots",
            "name": "itemLots",
            "kind": "collection"
        }
    ]
}"
Back to Top