API

Logistics APIs

GET logistics/pick-lists?createdForObjectType={objectType}&createdForObjectId={objectId}

List of picking routes

HTTP method GET
URI https://api.rambase.net/logistics/pick-lists?createdForObjectType={objectType}&createdForObjectId={objectId}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 4290, version 13

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

createdForObjectType String, optional Type of an object for which the pick list was created
createdForObjectId Integer, optional Identifier of an object for which the pick list was created
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

Active() Named filter Registered picking lists (status 4)
AssignedToMe() Named filter Picking lists assigned to me
New() Named filter Pending registration picking lists (status 1)
PickingNotInProgress() Named filter Picking lists that are not in progress
Processed() Named filter Processed picking lists (status 9)
AssigneeId Integer Employee identifier. Available macros: currentUser()
CreatedBy Integer Employee identifier.
CreatedForObjectId Integer Reference to an identifier of the belonging document.
CreatedForObjectType String Reference to an object type of the belonging document.
IsPickingInProgress Boolean Indicates if someone has confirmed pick on the picking list.
Name String Name of the pick list.
PickListId Integer Pick list identifier.
Priority Integer Priority of the picking list.
ProjectOrderId Integer Project order identifier.
Status Integer Status of the pick list.

Read more about filters and sorting on how to use sortable parameters

AssigneeId Integer Employee identifier
CreatedBy Integer Employee identifier
CreatedForObjectId Integer Reference to an identifier of the belonging document
CreatedForObjectType String Reference to an object type of the belonging document
IsPickingInProgress Boolean Indicates if someone has confirmed pick on the picking list
Name String Name of the pick list
PickListId Integer Pick list identifier
Priority Integer Priority of the picking list
ProjectOrderId Integer Project order identifier
Status Integer Status of the pick list

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<PickLists>
2
     <PickList>
3
          <PickListId
PickListId

Pick list identifier

>{Integer}</PickListId>
4
          <Status
Status

Status of the pick list

Possible domain values can be found here

>{Integer}</Status>
5
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
          <Name
Name

Name of the pick list

>{String}</Name>
7
          <RoutingStrategy
RoutingStrategy

Reference to a specific sort type / domain value (DOV)

Possible domain values can be found here

>{Integer}</RoutingStrategy>
8
          <IsPickingInProgress
IsPickingInProgress

Indicates if someone has confirmed pick on the picking list

>{Boolean}</IsPickingInProgress>
9
          <Priority
Priority

Priority of the picking list

Possible domain values can be found here

>{Integer}</Priority>
10
          <NumberOfPicks
NumberOfPicks

Total number of picks related to the PIL

>{Integer}</NumberOfPicks>
11
          <Assignee>
12
               <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
13
               <Name
Name

Last name of employee

>{String}</Name>
14
               <FirstName
FirstName

First name of employee

>{String}</FirstName>
15
               <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
16
          </Assignee>
17
          <CreatedBy
CreatedBy

Reference to an user responsible for the pick list

>
18
               <UserId
UserId

User identifier

>{Integer}</UserId>
19
               <Name
Name

Name of the user

>{String}</Name>
20
               <FirstName
FirstName

First name of the user

>{String}</FirstName>
21
               <UserLink
UserLink

User reference

>{String}</UserLink>
22
          </CreatedBy>
23
          <ProductStructureOperation
ProductStructureOperation

Product structure operation reference

This field is greyed out because it is an expandable field. You have to add $expand=PickList.ProductStructureOperation in your request URI to get this field

>
24
               <ProductStructureOperationId
ProductStructureOperationId

Product structure operation identifier

This field is greyed out because it is an expandable field. You have to add $expand=PickList.ProductStructureOperation in your request URI to get this field

>{Integer}</ProductStructureOperationId>
25
               <SequenceNumber
SequenceNumber

Sequence number of the product structure operation. Unique within a product structure.

This field is greyed out because it is an expandable field. You have to add $expand=PickList.ProductStructureOperation in your request URI to get this field

>{Integer}</SequenceNumber>
26
               <ProductStructure
ProductStructure

This field is greyed out because it is an expandable field. You have to add $expand=PickList.ProductStructureOperation in your request URI to get this field

>
27
                    <ProductStructureId
ProductStructureId

Product structure identifier

This field is greyed out because it is an expandable field. You have to add $expand=PickList.ProductStructureOperation in your request URI to get this field

>{Integer}</ProductStructureId>
28
                    <ProductStructureLink
ProductStructureLink

Product structure reference

This field is greyed out because it is an expandable field. You have to add $expand=PickList.ProductStructureOperation in your request URI to get this field

>{String}</ProductStructureLink>
29
               </ProductStructure>
30
               <ProductStructureOperationLink
ProductStructureOperationLink

Product structure operation reference

This field is greyed out because it is an expandable field. You have to add $expand=PickList.ProductStructureOperation in your request URI to get this field

>{String}</ProductStructureOperationLink>
31
          </ProductStructureOperation>
32
          <ProjectOrder
ProjectOrder

Reference to the project order this picking list belongs to

This field is greyed out because it is an expandable field. You have to add $expand=PickList.ProjectOrder in your request URI to get this field

>
33
               <ProjectOrderId
ProjectOrderId

Project order identifier

This field is greyed out because it is an expandable field. You have to add $expand=PickList.ProjectOrder in your request URI to get this field

>{Integer}</ProjectOrderId>
34
               <ProjectOrderLink
ProjectOrderLink

Project order reference

This field is greyed out because it is an expandable field. You have to add $expand=PickList.ProjectOrder in your request URI to get this field

>{String}</ProjectOrderLink>
35
          </ProjectOrder>
36
     </PickList>
37
     <Paging
Paging

Detailed paging information for this list.

>
38
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
39
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
40
          <Page
Page

Page index

>{Integer}</Page>
41
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
42
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
43
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
44
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
45
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
46
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
47
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
48
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
49
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
50
     </Paging>
51
</PickLists>
1
{
2
     "pickLists": [
3
          {
4
               "pickListId
PickListId

Pick list identifier

": "{Integer}",
5
               "status
Status

Status of the pick list

Possible domain values can be found here

": "{Integer}",
6
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
               "name
Name

Name of the pick list

": "{String}",
8
               "routingStrategy
RoutingStrategy

Reference to a specific sort type / domain value (DOV)

Possible domain values can be found here

": "{Integer}",
9
               "isPickingInProgress
IsPickingInProgress

Indicates if someone has confirmed pick on the picking list

": "{Boolean}",
10
               "priority
Priority

Priority of the picking list

Possible domain values can be found here

": "{Integer}",
11
               "numberOfPicks
NumberOfPicks

Total number of picks related to the PIL

": "{Integer}",
12
               "assignee": {
13
                    "employeeId
EmployeeId

Employee identifier

": "{Integer}",
14
                    "name
Name

Last name of employee

": "{String}",
15
                    "firstName
FirstName

First name of employee

": "{String}",
16
                    "employeeLink
EmployeeLink

Employee reference

": "{String}"
17
               },
18
               "createdBy
CreatedBy

Reference to an user responsible for the pick list

": {
19
                    "userId
UserId

User identifier

": "{Integer}",
20
                    "name
Name

Name of the user

": "{String}",
21
                    "firstName
FirstName

First name of the user

": "{String}",
22
                    "userLink
UserLink

User reference

": "{String}"
23
               },
24
               "productStructureOperation
ProductStructureOperation

Product structure operation reference

This field is greyed out because it is an expandable field. You have to add $expand=PickList.ProductStructureOperation in your request URI to get this field

": {
25
                    "productStructureOperationId
ProductStructureOperationId

Product structure operation identifier

This field is greyed out because it is an expandable field. You have to add $expand=PickList.ProductStructureOperation in your request URI to get this field

": "{Integer}",
26
                    "sequenceNumber
SequenceNumber

Sequence number of the product structure operation. Unique within a product structure.

This field is greyed out because it is an expandable field. You have to add $expand=PickList.ProductStructureOperation in your request URI to get this field

": "{Integer}",
27
                    "productStructure
ProductStructure

This field is greyed out because it is an expandable field. You have to add $expand=PickList.ProductStructureOperation in your request URI to get this field

": {
28
                         "productStructureId
ProductStructureId

Product structure identifier

This field is greyed out because it is an expandable field. You have to add $expand=PickList.ProductStructureOperation in your request URI to get this field

": "{Integer}",
29
                         "productStructureLink
ProductStructureLink

Product structure reference

This field is greyed out because it is an expandable field. You have to add $expand=PickList.ProductStructureOperation in your request URI to get this field

": "{String}"
30
                    },
31
                    "productStructureOperationLink
ProductStructureOperationLink

Product structure operation reference

This field is greyed out because it is an expandable field. You have to add $expand=PickList.ProductStructureOperation in your request URI to get this field

": "{String}"
32
               },
33
               "projectOrder
ProjectOrder

Reference to the project order this picking list belongs to

This field is greyed out because it is an expandable field. You have to add $expand=PickList.ProjectOrder in your request URI to get this field

": {
34
                    "projectOrderId
ProjectOrderId

Project order identifier

This field is greyed out because it is an expandable field. You have to add $expand=PickList.ProjectOrder in your request URI to get this field

": "{Integer}",
35
                    "projectOrderLink
ProjectOrderLink

Project order reference

This field is greyed out because it is an expandable field. You have to add $expand=PickList.ProjectOrder in your request URI to get this field

": "{String}"
36
               }
37
          }
38
     ],
39
     "paging
Paging

Detailed paging information for this list.

": {
40
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
41
          "position
Position

Position of the first element in the list

": "{Integer}",
42
          "page
Page

Page index

": "{Integer}",
43
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
44
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
45
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
46
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
47
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
48
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
49
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
50
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
51
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
52
     }
53
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101013 HTTP 404 Sub-module not found
Error 105969 HTTP 400 Start date is required
Error 105970 HTTP 400 End date is required