API

Logistics APIs

GET logistics/pick-lists/{pickListId}

Pick list details for the provided identifier

HTTP method GET
URI https://api.rambase.net/logistics/pick-lists/{pickListId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {pickListId} Pick list identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 4292, version 10

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.

$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.

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

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

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
<PickList>
2
     <PickListId
PickListId

Pick list identifier

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

Status of the pick list

Possible domain values can be found here

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

Date and time of creation

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

Name of the pick list

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

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

Possible domain values can be found here

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

Indicates if someone has confirmed pick on the picking list

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

Priority of the picking list

Possible domain values can be found here

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

Total number of picks related to the PIL

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

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

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

Reference to an user responsible for the pick list

>
17
          <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

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

Product structure operation reference

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

>
23
          <ProductStructureOperationId
ProductStructureOperationId

Product structure operation identifier

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

>{Integer}</ProductStructureOperationId>
24
          <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=ProductStructureOperation in your request URI to get this field

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

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

>
26
               <ProductStructureId
ProductStructureId

Product structure identifier

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

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

Product structure reference

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

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

Product structure operation reference

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

>{String}</ProductStructureOperationLink>
30
     </ProductStructureOperation>
31
     <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=ProjectOrder in your request URI to get this field

>
32
          <ProjectOrderId
ProjectOrderId

Project order identifier

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

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

Project order reference

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

>{String}</ProjectOrderLink>
34
     </ProjectOrder>
35
</PickList>
1
{
2
     "pickList": {
3
          "pickListId
PickListId

Pick list identifier

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

Status of the pick list

Possible domain values can be found here

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

Date and time of creation

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

Name of the pick list

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

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

Possible domain values can be found here

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

Indicates if someone has confirmed pick on the picking list

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

Priority of the picking list

Possible domain values can be found here

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

Total number of picks related to the PIL

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

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

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

Reference to an user responsible for the pick list

": {
18
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

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

Product structure operation reference

This field is greyed out because it is an expandable field. You have to add $expand=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=ProductStructureOperation in your request URI to get this field

": "{Integer}",
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=ProductStructureOperation in your request URI to get this field

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

This field is greyed out because it is an expandable field. You have to add $expand=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=ProductStructureOperation in your request URI to get this field

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

Product structure reference

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

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

Product structure operation reference

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

": "{String}"
31
          },
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=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=ProjectOrder in your request URI to get this field

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

Project order reference

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

": "{String}"
35
          }
36
     }
37
}

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 101746 HTTP 404 Product structure not found. Id: {0}