API

Logistics APIs

GET logistics/stock-takings/{stockTakingId}/count-locations

List of count locations for given stock taking. This list returns all unique combinations of goods reception counts and stock locations, detault sorted by stock location. This list could be used as an action list when performing stock taking. When counted, a stock location count will be created. Note that the expected stock quantity for the count locations can change after beeing counted.

HTTP method GET
URI https://api.rambase.net/logistics/stock-takings/{stockTakingId}/count-locations
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {stockTakingId} Stock taking identifier
Integer, minimum 100000
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 2199, version 7

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.

$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.

GoodsReceptionId Integer Goods reception identifier.
GoodsReceptionItemId Integer Item-/line-number of the goods reception.
IsCounted Boolean True if stock location is counted for the specified goods reception count..
StockLocationAssignmentStatus Integer Status of stock location assignment.
StockLocationId Integer Stock location identifier.
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

GoodsReceptionId Integer Goods reception identifier
GoodsReceptionItemId Integer Item-/line-number of the goods reception
IsCounted Boolean True if stock location is counted for the specified goods reception count.
StockLocationAssignmentStatus Integer Status of stock location assignment
StockLocationId Integer Stock location identifier
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.

Format:
1
<CountLocations>
2
     <CountLocation>
3
          <IsCounted
IsCounted

True if stock location is counted for the specified goods reception count.

>{Boolean}</IsCounted>
4
          <ExpectedStockQuantity
ExpectedStockQuantity

Expected stock quantity for this count location (combination of goods reception count and stock location). This quantity might change after counting is completed. Note that this quantity is always the same as the remaining quantity of the stock location assignment.

>{Decimal}</ExpectedStockQuantity>
5
          <GoodsReceptionCount>
6
               <GoodsReceptionCountId
GoodsReceptionCountId

Goods reception count identifier

>{Integer}</GoodsReceptionCountId>
7
               <GoodsReceptionItem>
8
                    <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

>{Integer}</GoodsReceptionItemId>
9
                    <GoodsReception>
10
                         <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

>{Integer}</GoodsReceptionId>
11
                         <Product
Product

This field is greyed out because it is an expandable field. You have to add $expand=CountLocation.GoodsReceptionCount.GoodsReceptionItem.GoodsReception.Product in your request URI to get this field

>
12
                              <ProductId
ProductId

Product identifier

This field is greyed out because it is an expandable field. You have to add $expand=CountLocation.GoodsReceptionCount.GoodsReceptionItem.GoodsReception.Product in your request URI to get this field

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

Name of the product

This field is greyed out because it is an expandable field. You have to add $expand=CountLocation.GoodsReceptionCount.GoodsReceptionItem.GoodsReception.Product in your request URI to get this field

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

Description of the product

This field is greyed out because it is an expandable field. You have to add $expand=CountLocation.GoodsReceptionCount.GoodsReceptionItem.GoodsReception.Product in your request URI to get this field

>{String}</Description>
15
                              <ProductLink
ProductLink

Product reference

This field is greyed out because it is an expandable field. You have to add $expand=CountLocation.GoodsReceptionCount.GoodsReceptionItem.GoodsReception.Product in your request URI to get this field

>{String}</ProductLink>
16
                         </Product>
17
                         <GoodsReceptionLink
GoodsReceptionLink

Goods reception reference

>{String}</GoodsReceptionLink>
18
                    </GoodsReception>
19
                    <GoodsReceptionItemLink
GoodsReceptionItemLink

Item-/line-number of the goods reception

>{String}</GoodsReceptionItemLink>
20
               </GoodsReceptionItem>
21
               <GoodsReceptionCountLink
GoodsReceptionCountLink

Goods reception count reference

>{String}</GoodsReceptionCountLink>
22
          </GoodsReceptionCount>
23
          <StockLocation>
24
               <StockLocationId
StockLocationId

Stock location identifier

>{Integer}</StockLocationId>
25
               <Label
Label

Name of current- and parent stock locations, including seperator for location

>{String}</Label>
26
               <StockLocationLink
StockLocationLink

Stock location reference

>{String}</StockLocationLink>
27
          </StockLocation>
28
          <StockLocationCount>
29
               <StockLocationCountId
StockLocationCountId

Stock location count identifier

>{Integer}</StockLocationCountId>
30
               <CountedStockQuantity
CountedStockQuantity

The counted/actual quantity found when counting the goods reception item for the stock location

>{Decimal}</CountedStockQuantity>
31
               <ExpectedStockQuantity
ExpectedStockQuantity

Expected quantity to be found when counting the goods reception item in stock location. Note that this field will not be set before you have actually started counting. Also note that when the stock location count is created, this expected quantity is set equal to the remaining quantity of the stock location assignment.

>{Decimal}</ExpectedStockQuantity>
32
               <StockLocationCountLink
StockLocationCountLink

Stock location count reference

>{String}</StockLocationCountLink>
33
          </StockLocationCount>
34
     </CountLocation>
35
     <Paging
Paging

Detailed paging information for this list.

>
36
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
39
          <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>
40
          <FirstPage
FirstPage

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

>{String}</FirstPage>
41
          <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>
42
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
43
          <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>
44
          <NextPage
NextPage

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

>{String}</NextPage>
45
          <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>
46
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
48
     </Paging>
49
</CountLocations>
1
{
2
     "countLocations": [
3
          {
4
               "isCounted
IsCounted

True if stock location is counted for the specified goods reception count.

": "{Boolean}",
5
               "expectedStockQuantity
ExpectedStockQuantity

Expected stock quantity for this count location (combination of goods reception count and stock location). This quantity might change after counting is completed. Note that this quantity is always the same as the remaining quantity of the stock location assignment.

": "{Decimal}",
6
               "goodsReceptionCount": {
7
                    "goodsReceptionCountId
GoodsReceptionCountId

Goods reception count identifier

": "{Integer}",
8
                    "goodsReceptionItem": {
9
                         "goodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

": "{Integer}",
10
                         "goodsReception": {
11
                              "goodsReceptionId
GoodsReceptionId

Goods reception identifier

": "{Integer}",
12
                              "product
Product

This field is greyed out because it is an expandable field. You have to add $expand=CountLocation.GoodsReceptionCount.GoodsReceptionItem.GoodsReception.Product in your request URI to get this field

": {
13
                                   "productId
ProductId

Product identifier

This field is greyed out because it is an expandable field. You have to add $expand=CountLocation.GoodsReceptionCount.GoodsReceptionItem.GoodsReception.Product in your request URI to get this field

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

Name of the product

This field is greyed out because it is an expandable field. You have to add $expand=CountLocation.GoodsReceptionCount.GoodsReceptionItem.GoodsReception.Product in your request URI to get this field

": "{String}",
15
                                   "description
Description

Description of the product

This field is greyed out because it is an expandable field. You have to add $expand=CountLocation.GoodsReceptionCount.GoodsReceptionItem.GoodsReception.Product in your request URI to get this field

": "{String}",
16
                                   "productLink
ProductLink

Product reference

This field is greyed out because it is an expandable field. You have to add $expand=CountLocation.GoodsReceptionCount.GoodsReceptionItem.GoodsReception.Product in your request URI to get this field

": "{String}"
17
                              },
18
                              "goodsReceptionLink
GoodsReceptionLink

Goods reception reference

": "{String}"
19
                         },
20
                         "goodsReceptionItemLink
GoodsReceptionItemLink

Item-/line-number of the goods reception

": "{String}"
21
                    },
22
                    "goodsReceptionCountLink
GoodsReceptionCountLink

Goods reception count reference

": "{String}"
23
               },
24
               "stockLocation": {
25
                    "stockLocationId
StockLocationId

Stock location identifier

": "{Integer}",
26
                    "label
Label

Name of current- and parent stock locations, including seperator for location

": "{String}",
27
                    "stockLocationLink
StockLocationLink

Stock location reference

": "{String}"
28
               },
29
               "stockLocationCount": {
30
                    "stockLocationCountId
StockLocationCountId

Stock location count identifier

": "{Integer}",
31
                    "countedStockQuantity
CountedStockQuantity

The counted/actual quantity found when counting the goods reception item for the stock location

": "{Decimal}",
32
                    "expectedStockQuantity
ExpectedStockQuantity

Expected quantity to be found when counting the goods reception item in stock location. Note that this field will not be set before you have actually started counting. Also note that when the stock location count is created, this expected quantity is set equal to the remaining quantity of the stock location assignment.

": "{Decimal}",
33
                    "stockLocationCountLink
StockLocationCountLink

Stock location count reference

": "{String}"
34
               }
35
          }
36
     ],
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}",
39
          "position
Position

Position of the first element in the list

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

Page index

": "{Integer}",
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}",
42
          "firstPage
FirstPage

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

": "{String}",
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}",
44
          "previousPage
PreviousPage

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

": "{String}",
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}",
46
          "nextPage
NextPage

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

": "{String}",
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}",
48
          "lastPage
LastPage

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

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

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

": "{Integer}"
50
     }
51
}

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 100036 HTTP 400 Missing required input parameter: {0}
Error 101420 HTTP 404 Setting definition not found