Logistics APIs
List of all assignments for provided object, with additional picking information. If a picking route exists, the list will be sorted by it.
| HTTP method | GET |
| URI | https://api.rambase.net/logistics/pick-assignments?objectType={objectType}&objectId={objectId}&itemId={itemId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 2359, version 16 |
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.
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.
| objectType String, required | Type of object |
| objectId Integer, required | Identifier of the object |
| itemId Integer, optional | Item-number of the object |
| $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.
| OnlyConsumptionParts() Named filter | Type of product |
| PickInitialized() Named filter | Status of pick operation |
| PickNotStarted() Named filter | Status of pick operation |
| AssignedToId Integer | Assignment document identifier. |
| AssignedToItemId Integer | Assignment item identifier. |
| AssignmentId Integer | Allocation identifier. |
| AssignmentRegisterId Integer | Assignment register identifier. |
| AssignmentRegisterOwnerType String | Type of assignment register. |
| OperationSequenceNumber Integer | Sequence number of the product structure operation. Unique within a product structure. |
| OwnerObjectId Integer | Identifier of the object. |
| PickStatus Integer | Status of the picking from this assignment. Note that the pick status of the assignment might differ from the status of the pick operation of the assigned item.. |
| ProductId Integer | Product identifier. |
| ProductName String | Name of the product. |
| ProductType String | Type of product. |
| Quantity Decimal | Quantity assigned. |
| StockLocationLabel String | Name of current- and parent stock locations, including seperator for location. |
Read more about filters and sorting on how to use sortable parameters
| AssignedToItemId Integer | Assignment item identifier |
| OwnerObjectId Integer | Identifier of the object |
| ProductId Integer | Product identifier |
| ProductName String | Name of the product |
| StockLocationLabel String | Name of current- and parent stock locations, including seperator for location |
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.
SortingPriority
Sort order of the picking route
>{Integer}</SortingPriority>StockLocationId
Stock location identifier
>{Integer}</StockLocationId>Label
Name of current- and parent stock locations, including seperator for location
>{String}</Label>StockLocationLink
Stock location reference
>{String}</StockLocationLink>PickOperationId
Pick operation identifier
>{Integer}</PickOperationId>PickOperationLink
Pick operation reference
>{String}</PickOperationLink>AssignmentId
Allocation identifier
>{Integer}</AssignmentId>Quantity
Quantity assigned
>{Decimal}</Quantity>ObjectId
Identifier of the object
>{Integer}</ObjectId>ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ItemLink
API reference to the item
>{String}</ItemLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ProductStructureMaterialId
Product structure material identifier
>{Integer}</ProductStructureMaterialId>SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
>{Integer}</SequenceNumber>ProductStructureId
Assignment register identifier
>{Integer}</ProductStructureId>ProductStructureLink
Assignment register identifier
>{String}</ProductStructureLink>ProductStructureMaterialLink
Product structure material reference
>{String}</ProductStructureMaterialLink>ProductStructureOperationId
Product structure operation identifier
>{Integer}</ProductStructureOperationId>SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
>{Integer}</SequenceNumber>ProductStructureId
Assignment register identifier
>{Integer}</ProductStructureId>ProductStructureLink
Assignment register identifier
>{String}</ProductStructureLink>ProductStructureOperationLink
Product structure operation reference
>{String}</ProductStructureOperationLink>PickStatus
Status of the picking from this assignment. Note that the pick status of the assignment might differ from the status of the pick operation of the assigned item.
Possible domain values can be found here
>{Integer}</PickStatus>AssignmentRegisterId
Assignment register identifier
>{Integer}</AssignmentRegisterId>OwnerType
Type of assignment register
Possible domain values can be found here
>{String}</OwnerType>ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ProductStructureRevision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
>{String}</ProductStructureRevision>MeasurementUnitId
Material unit reference
>{Integer}</MeasurementUnitId>MeasurementUnitLink
Material unit reference
>{String}</MeasurementUnitLink>Database
Database of the object
>{String}</Database>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemLink
API reference to the item
>{String}</ItemLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductLink
Product reference
>{String}</ProductLink>AssignmentRegisterLink
Assignment register reference
>{String}</AssignmentRegisterLink>AssignmentLink
Assignment reference
>{String}</AssignmentLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>SortingPriority
Sort order of the picking route
": "{Integer}",StockLocationId
Stock location identifier
": "{Integer}",Label
Name of current- and parent stock locations, including seperator for location
": "{String}",StockLocationLink
Stock location reference
": "{String}"PickOperationId
Pick operation identifier
": "{Integer}",PickOperationLink
Pick operation reference
": "{String}"AssignmentId
Allocation identifier
": "{Integer}",Quantity
Quantity assigned
": "{Decimal}",ObjectId
Identifier of the object
": "{Integer}",ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",ItemLink
API reference to the item
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}"ProductStructureMaterialId
Product structure material identifier
": "{Integer}",SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
": "{Integer}"ProductStructureId
Assignment register identifier
": "{Integer}",ProductStructureLink
Assignment register identifier
": "{String}"ProductStructureMaterialLink
Product structure material reference
": "{String}"ProductStructureOperationId
Product structure operation identifier
": "{Integer}",SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
": "{Integer}",ProductStructureId
Assignment register identifier
": "{Integer}",ProductStructureLink
Assignment register identifier
": "{String}"ProductStructureOperationLink
Product structure operation reference
": "{String}"PickStatus
Status of the picking from this assignment. Note that the pick status of the assignment might differ from the status of the pick operation of the assigned item.
Possible domain values can be found here
": "{Integer}",AssignmentRegisterId
Assignment register identifier
": "{Integer}",OwnerType
Type of assignment register
Possible domain values can be found here
": "{String}",ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",ProductStructureRevision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
": "{String}",MeasurementUnitId
Material unit reference
": "{Integer}",MeasurementUnitLink
Material unit reference
": "{String}"Database
Database of the object
": "{String}",ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}"ItemLink
API reference to the item
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",Description
Description of the product
": "{String}",ProductLink
Product reference
": "{String}"AssignmentRegisterLink
Assignment register reference
": "{String}"AssignmentLink
Assignment reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 |
| Error 102189 HTTP 400 | Missing mandatory parameter for goods reception item id |