API

Logistics APIs

POST logistics/stock-takings

Create new stock taking

HTTP method POST
URI https://api.rambase.net/logistics/stock-takings
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 2195, 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
<StockTaking>
2
     <Name
Name

Name of stock taking

This field is optional.

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

Required/mandatory field

Type of stock taking

Applicable domain values can be found here

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

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

Default value: False

This field is optional.

>{Boolean}</CountSelectedAreaOnly>
5
     <CountedBy
CountedBy

Employee who perform the stock taking

This field is optional.

>
6
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
7
     </CountedBy>
8
     <FromStockLocation
FromStockLocation

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

This field is optional.

>
9
          <StockLocationId
StockLocationId

Stock location identifier

Minimum value: 100000

This field is optional.

>{Integer}</StockLocationId>
10
     </FromStockLocation>
11
     <ToStockLocation
ToStockLocation

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

This field is optional.

>
12
          <StockLocationId
StockLocationId

Stock location identifier

Minimum value: 100000

This field is optional.

>{Integer}</StockLocationId>
13
     </ToStockLocation>
14
</StockTaking>
1
{
2
     "stockTaking": {
3
          "name
Name

Name of stock taking

This field is optional.

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

Required/mandatory field

Type of stock taking

Applicable domain values can be found here

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

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

Default value: False

This field is optional.

": "{Boolean}",
6
          "countedBy
CountedBy

Employee who perform the stock taking

This field is optional.

": {
7
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
8
          },
9
          "fromStockLocation
FromStockLocation

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

This field is optional.

": {
10
               "stockLocationId
StockLocationId

Stock location identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
11
          },
12
          "toStockLocation
ToStockLocation

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

This field is optional.

": {
13
               "stockLocationId
StockLocationId

Stock location identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
14
          }
15
     }
16
}

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.

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

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.

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
          <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
12
     </CreatedBy>
13
     <CountedBy
CountedBy

Employee who perform the stock taking

>
14
          <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
15
          <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
16
     </CountedBy>
17
     <FromStockLocation
FromStockLocation

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

>
18
          <StockLocationId
StockLocationId

Stock location identifier

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

Stock location reference

>{String}</StockLocationLink>
20
     </FromStockLocation>
21
     <ToStockLocation
ToStockLocation

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

>
22
          <StockLocationId
StockLocationId

Stock location identifier

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

Stock location reference

>{String}</StockLocationLink>
24
     </ToStockLocation>
25
</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
               "employeeLink
EmployeeLink

Employee reference

": "{String}"
13
          },
14
          "countedBy
CountedBy

Employee who perform the stock taking

": {
15
               "employeeId
EmployeeId

Employee identifier

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

Employee reference

": "{String}"
17
          },
18
          "fromStockLocation
FromStockLocation

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

": {
19
               "stockLocationId
StockLocationId

Stock location identifier

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

Stock location reference

": "{String}"
21
          },
22
          "toStockLocation
ToStockLocation

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

": {
23
               "stockLocationId
StockLocationId

Stock location identifier

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

Stock location reference

": "{String}"
25
          }
26
     }
27
}

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 101814 HTTP 404 Employee not found
Error 104394 HTTP 400 Both FromStockLocation and ToStockLocation must be given
Error 104395 HTTP 400 FromStockLocation cannot come after ToStockLocation