API

Logistics APIs

GET logistics/stock-location-assignments

List of all stock location assignments

HTTP method GET
URI https://api.rambase.net/logistics/stock-location-assignments
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 1997, version 24

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

Active() Named filter Active stock location assignemnts (status less than 9)
ContainsSecondHandProducts Boolean True if location contains second hand products. Location will be blocked for stock assignments.
ContainsSparepartsUsedForRepair Boolean True if location contains spareparts used for repair.
Database String Company code/database the object belongs to.
GoodsReceptionId Integer Goods reception identifier.
GoodsReceptionItemId Integer Item-/line-number of the goods reception.
IsBlockedForPicking Boolean True if picking from this stock location is not allowed.
IsBlockedForStockAssignments Boolean True if block linking.
LocationId Integer Location identifier.
ManufacturersProductName String Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).
ProductDescription String Description of the product.
ProductId Integer Assignment register identifier.
ProductName String Name of the product.
Quantity Decimal Initial quantity placed in the stock location.
RemainingQuantity Decimal Quantity from goods reception item remaining in stock location.
Status Integer Status of stock location assignment.
StockAssignmentId Integer Assignment register identifier.
StockLocationAssignmentId Integer Stock location assignment identifier.
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

ContainsSecondHandProducts Boolean True if location contains second hand products. Location will be blocked for stock assignments.
ContainsSparepartsUsedForRepair Boolean True if location contains spareparts used for repair.
Database String Company code/database the object belongs to
GoodsReceptionId Integer Goods reception identifier
GoodsReceptionItemId Integer Item-/line-number of the goods reception
IsBlockedForPicking Boolean True if picking from this stock location is not allowed
IsBlockedForStockAssignments Boolean True if block linking
LocationId Integer Location identifier
ManufacturersProductName String Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).
ProductDescription String Description of the product
ProductId Integer Assignment register identifier
ProductName String Name of the product
Quantity Decimal Initial quantity placed in the stock location
RemainingQuantity Decimal Quantity from goods reception item remaining in stock location
Status Integer Status of stock location assignment
StockAssignmentId Integer Assignment register identifier
StockLocationAssignmentId Integer Stock location assignment identifier
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
<StockLocationAssignments>
2
     <StockLocationAssignment>
3
          <StockLocationAssignmentId
StockLocationAssignmentId

Stock location assignment identifier

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

Status of stock location assignment

Possible domain values can be found here

>{Integer}</Status>
5
          <Quantity
Quantity

Initial quantity placed in the stock location

>{Decimal}</Quantity>
6
          <RemainingQuantity
RemainingQuantity

Quantity from goods reception item remaining in stock location

>{Decimal}</RemainingQuantity>
7
          <IsBlockedForPicking
IsBlockedForPicking

True if picking from this stock location is not allowed

>{Boolean}</IsBlockedForPicking>
8
          <IsBlockedForStockAssignments
IsBlockedForStockAssignments

True if block linking

>{Boolean}</IsBlockedForStockAssignments>
9
          <ContainsSecondHandProducts
ContainsSecondHandProducts

True if location contains second hand products. Location will be blocked for stock assignments.

>{Boolean}</ContainsSecondHandProducts>
10
          <ContainsSparepartsUsedForRepair
ContainsSparepartsUsedForRepair

True if location contains spareparts used for repair.

>{Boolean}</ContainsSparepartsUsedForRepair>
11
          <ManufacturersProduct
ManufacturersProduct

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

>
12
               <ManufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

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

Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).

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

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

Manufacturers product reference

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

>{String}</ManufacturersProductLink>
15
          </ManufacturersProduct>
16
          <GoodsReceptionItem>
17
               <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

>{Integer}</GoodsReceptionItemId>
18
               <Database
Database

Company code/database the object belongs to

>{String}</Database>
19
               <GoodsReception>
20
                    <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

>{Integer}</GoodsReceptionId>
21
                    <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
22
                    <GoodsReceptionLink
GoodsReceptionLink

Goods reception identifier

>{String}</GoodsReceptionLink>
23
               </GoodsReception>
24
               <Price>
25
                    <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
26
                    <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

>{Decimal}</NetPrice>
27
               </Price>
28
               <Totals>
29
                    <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
30
                    <NetAmount
NetAmount

Final item amount after deducting all discounts etc.

>{Decimal}</NetAmount>
31
               </Totals>
32
               <Product>
33
                    <ProductId
ProductId

Assignment register identifier

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

Name of the product

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

Description of the product

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

Product reference

>{String}</ProductLink>
37
               </Product>
38
               <ProductRevision
ProductRevision

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

>
39
                    <Revision
Revision

The Revision of the product

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

>{String}</Revision>
40
               </ProductRevision>
41
               <GoodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

>{String}</GoodsReceptionItemLink>
42
          </GoodsReceptionItem>
43
          <StockLocation>
44
               <StockLocationId
StockLocationId

Stock location identifier

>{Integer}</StockLocationId>
45
               <Name
Name

Name of stock location

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

>{String}</Name>
46
               <Label
Label

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

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

>{String}</Label>
47
               <IsBlockedForStock
IsBlockedForStock

Determines whether or not this stock location is blocked for stock

>{Boolean}</IsBlockedForStock>
48
               <Location>
49
                    <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
50
                    <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
51
               </Location>
52
               <StockLocationLink
StockLocationLink

Stock location reference

>{String}</StockLocationLink>
53
          </StockLocation>
54
          <StockLocationAssignmentLink
StockLocationAssignmentLink

Reference to stock location assignment

>{String}</StockLocationAssignmentLink>
55
     </StockLocationAssignment>
56
     <Paging
Paging

Detailed paging information for this list.

>
57
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
60
          <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>
61
          <FirstPage
FirstPage

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

>{String}</FirstPage>
62
          <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>
63
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
64
          <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>
65
          <NextPage
NextPage

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

>{String}</NextPage>
66
          <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>
67
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
69
     </Paging>
70
</StockLocationAssignments>
1
{
2
     "stockLocationAssignments": [
3
          {
4
               "stockLocationAssignmentId
StockLocationAssignmentId

Stock location assignment identifier

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

Status of stock location assignment

Possible domain values can be found here

": "{Integer}",
6
               "quantity
Quantity

Initial quantity placed in the stock location

": "{Decimal}",
7
               "remainingQuantity
RemainingQuantity

Quantity from goods reception item remaining in stock location

": "{Decimal}",
8
               "isBlockedForPicking
IsBlockedForPicking

True if picking from this stock location is not allowed

": "{Boolean}",
9
               "isBlockedForStockAssignments
IsBlockedForStockAssignments

True if block linking

": "{Boolean}",
10
               "containsSecondHandProducts
ContainsSecondHandProducts

True if location contains second hand products. Location will be blocked for stock assignments.

": "{Boolean}",
11
               "containsSparepartsUsedForRepair
ContainsSparepartsUsedForRepair

True if location contains spareparts used for repair.

": "{Boolean}",
12
               "manufacturersProduct
ManufacturersProduct

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

": {
13
                    "manufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

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

Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).

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

": "{String}",
15
                    "manufacturersProductLink
ManufacturersProductLink

Manufacturers product reference

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

": "{String}"
16
               },
17
               "goodsReceptionItem": {
18
                    "goodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

": "{Integer}",
19
                    "database
Database

Company code/database the object belongs to

": "{String}",
20
                    "goodsReception": {
21
                         "goodsReceptionId
GoodsReceptionId

Goods reception identifier

": "{Integer}",
22
                         "registrationDate
RegistrationDate

Date of registration

": "{Date}",
23
                         "goodsReceptionLink
GoodsReceptionLink

Goods reception identifier

": "{String}"
24
                    },
25
                    "price": {
26
                         "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
27
                         "netPrice
NetPrice

Final price per unit after deducting all discounts etc.

": "{Decimal}"
28
                    },
29
                    "totals": {
30
                         "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
31
                         "netAmount
NetAmount

Final item amount after deducting all discounts etc.

": "{Decimal}"
32
                    },
33
                    "product": {
34
                         "productId
ProductId

Assignment register identifier

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

Name of the product

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

Description of the product

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

Product reference

": "{String}"
38
                    },
39
                    "productRevision
ProductRevision

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

": {
40
                         "revision
Revision

The Revision of the product

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

": "{String}"
41
                    },
42
                    "goodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

": "{String}"
43
               },
44
               "stockLocation": {
45
                    "stockLocationId
StockLocationId

Stock location identifier

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

Name of stock location

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

": "{String}",
47
                    "label
Label

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

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

": "{String}",
48
                    "isBlockedForStock
IsBlockedForStock

Determines whether or not this stock location is blocked for stock

": "{Boolean}",
49
                    "location": {
50
                         "locationId
LocationId

Location identifier

": "{Integer}",
51
                         "locationLink
LocationLink

Location reference

": "{String}"
52
                    },
53
                    "stockLocationLink
StockLocationLink

Stock location reference

": "{String}"
54
               },
55
               "stockLocationAssignmentLink
StockLocationAssignmentLink

Reference to stock location assignment

": "{String}"
56
          }
57
     ],
58
     "paging
Paging

Detailed paging information for this list.

": {
59
          "pageSize
PageSize

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

": "{Integer}",
60
          "position
Position

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
71
     }
72
}

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 100050 HTTP 403 No admittance as customer {0}
Error 100053 HTTP 403 You have only admittance to your own suppliers
Error 101420 HTTP 404 Setting definition not found