API

Logistics APIs

GET logistics/stock-takings/{stockTakingId}

Stock taking details for provided identifier

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

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
<StockTaking>
2
     <StockTakingId
StockTakingId

Stock taking identifier

>{String}</StockTakingId>
3
     <Status
Status

Status of stock taking

Possible domain values can be found here

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

Name of stock taking

>{String}</Name>
5
     <Type
Type

Type of stock taking

Possible domain values can be found here

>{String}</Type>
6
     <CountSelectedAreaOnly
CountSelectedAreaOnly

Indicates that only goods within the area restricted by FromStockLocation and ToStockLocation should be counted

>{Boolean}</CountSelectedAreaOnly>
7
     <CompletedAt
CompletedAt

Date and time of completion

>{Datetime}</CompletedAt>
8
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
9
     <CreatedBy
CreatedBy

Employee who created the stock taking

>
10
          <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
11
          <LastName
LastName

Last name of employee

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

>{String}</LastName>
12
          <FirstName
FirstName

First name of employee

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

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

Employee reference

>{String}</EmployeeLink>
14
     </CreatedBy>
15
     <CountedBy
CountedBy

Employee who perform the stock taking

>
16
          <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
17
          <LastName
LastName

Last name of employee

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

>{String}</LastName>
18
          <FirstName
FirstName

First name of employee

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

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

Employee reference

>{String}</EmployeeLink>
20
     </CountedBy>
21
     <FromStockLocation
FromStockLocation

If FromStockLocationId is given, stock taking will be created for products that are stored within the area of this Id and ToStockLocationId.

>
22
          <StockLocationId
StockLocationId

Stock location identifier

>{Integer}</StockLocationId>
23
          <StockLocationLink
StockLocationLink

Stock location reference

>{String}</StockLocationLink>
24
     </FromStockLocation>
25
     <ToStockLocation
ToStockLocation

If ToStockLocationId is given, stock counting will be created for products that are stored within the area of FromStockLocationId and this Id

>
26
          <StockLocationId
StockLocationId

Stock location identifier

>{Integer}</StockLocationId>
27
          <StockLocationLink
StockLocationLink

Stock location reference

>{String}</StockLocationLink>
28
     </ToStockLocation>
29
</StockTaking>
1
{
2
     "stockTaking": {
3
          "stockTakingId
StockTakingId

Stock taking identifier

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

Status of stock taking

Possible domain values can be found here

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

Name of stock taking

": "{String}",
6
          "type
Type

Type of stock taking

Possible domain values can be found here

": "{String}",
7
          "countSelectedAreaOnly
CountSelectedAreaOnly

Indicates that only goods within the area restricted by FromStockLocation and ToStockLocation should be counted

": "{Boolean}",
8
          "completedAt
CompletedAt

Date and time of completion

": "{Datetime}",
9
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
10
          "createdBy
CreatedBy

Employee who created the stock taking

": {
11
               "employeeId
EmployeeId

Employee identifier

": "{Integer}",
12
               "lastName
LastName

Last name of employee

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

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

First name of employee

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

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

Employee reference

": "{String}"
15
          },
16
          "countedBy
CountedBy

Employee who perform the stock taking

": {
17
               "employeeId
EmployeeId

Employee identifier

": "{Integer}",
18
               "lastName
LastName

Last name of employee

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

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

First name of employee

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

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

Employee reference

": "{String}"
21
          },
22
          "fromStockLocation
FromStockLocation

If FromStockLocationId is given, stock taking will be created for products that are stored within the area of this Id and ToStockLocationId.

": {
23
               "stockLocationId
StockLocationId

Stock location identifier

": "{Integer}",
24
               "stockLocationLink
StockLocationLink

Stock location reference

": "{String}"
25
          },
26
          "toStockLocation
ToStockLocation

If ToStockLocationId is given, stock counting will be created for products that are stored within the area of FromStockLocationId and this Id

": {
27
               "stockLocationId
StockLocationId

Stock location identifier

": "{Integer}",
28
               "stockLocationLink
StockLocationLink

Stock location reference

": "{String}"
29
          }
30
     }
31
}

Possible error codes the response might return:

Error 101884 HTTP 400 Stock taking not found