Logistics APIs

GET logistics/stock-location-assignments/{stockLocationAssignmentId}

Stock location assignment details for provided identifier

HTTP method	GET
URI	https://api.rambase.net/logistics/stock-location-assignments/{stockLocationAssignmentId}
Supported formats	Xml, Html, Json (ex. $format=json)
- URI parameter {stockLocationAssignmentId}	Stock location assignment identifier Integer, minimum 100000
Successful HTTP status code	200
API resource identifier	1995, 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.

Format:

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:

                                        <StockLocationAssignment>
                                    

<StockLocationAssignmentId

StockLocationAssignmentId

Stock location assignment identifier

>{Integer}</StockLocationAssignmentId>

<Status

Status

Status of stock location assignment

Possible domain values can be found here

>{Integer}</Status>

<CreatedAt

CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>

<Quantity

Quantity

Initial quantity placed in the stock location

>{Decimal}</Quantity>

<RemainingQuantity

RemainingQuantity

Quantity from goods reception item remaining in stock location

>{Decimal}</RemainingQuantity>

<IsBlockedForPicking

IsBlockedForPicking

True if picking from this stock location is not allowed

>{Boolean}</IsBlockedForPicking>

<IsBlockedForStockAssignments

IsBlockedForStockAssignments

True if block linking

>{Boolean}</IsBlockedForStockAssignments>

<ContainsSecondHandProducts

ContainsSecondHandProducts

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

>{Boolean}</ContainsSecondHandProducts>

<ContainsSparepartsUsedForRepair

ContainsSparepartsUsedForRepair

True if location contains spareparts used for repair.

>{Boolean}</ContainsSparepartsUsedForRepair>

<ManufacturersProduct

ManufacturersProduct

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

<ManufacturersProductId

ManufacturersProductId

Manufacturer product identifier

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

>{Integer}</ManufacturersProductId>

<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=ManufacturersProduct in your request URI to get this field

>{String}</Name>

<ManufacturersProductLink

ManufacturersProductLink

Manufacturers product reference

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

>{String}</ManufacturersProductLink>

                                             </ManufacturersProduct>
                                    

                                             <GoodsReceptionItem>
                                    

<GoodsReceptionItemId

GoodsReceptionItemId

Item-/line-number of the goods reception

>{Integer}</GoodsReceptionItemId>

<Database

Database

Company code/database the object belongs to

>{String}</Database>

                                                  <GoodsReception>
                                    

<GoodsReceptionId

GoodsReceptionId

Goods reception identifier

>{Integer}</GoodsReceptionId>

<GoodsReceptionLink

GoodsReceptionLink

Goods reception identifier

>{String}</GoodsReceptionLink>

                                                  </GoodsReception>
                                    

                                                  <Product>
                                    

<ProductId

ProductId

Assignment register identifier

>{Integer}</ProductId>

<Name

Name

Name of the product

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

>{String}</Name>

<Description

Description

Description of the product

>{String}</Description>

<ProductLink

ProductLink

Product reference

>{String}</ProductLink>

                                                  </Product>
                                    

                                                  <StockAssignment>
                                    

<StockAssignmentId

StockAssignmentId

Assignment register identifier

>{Integer}</StockAssignmentId>

<StockAssignmentLink

StockAssignmentLink

Assignment register reference

>{String}</StockAssignmentLink>

                                                  </StockAssignment>
                                    

<GoodsReceptionItemLink

GoodsReceptionItemLink

Goods reception item reference

>{String}</GoodsReceptionItemLink>

                                             </GoodsReceptionItem>
                                    

                                             <StockLocation>
                                    

<StockLocationId

StockLocationId

Stock location identifier

>{Integer}</StockLocationId>

<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=StockLocation.Label in your request URI to get this field

>{String}</Label>

<IsBlockedForStock

IsBlockedForStock

Determines whether or not this stock location is blocked for stock

>{Boolean}</IsBlockedForStock>

                                                  <Location>
                                    

<LocationId

LocationId

Location identifier

>{Integer}</LocationId>

<LocationLink

LocationLink

Location reference

>{String}</LocationLink>

                                                  </Location>
                                    

<StockLocationLink

StockLocationLink

Stock location reference

>{String}</StockLocationLink>

                                             </StockLocation>
                                    

                                        </StockLocationAssignment>
                                    

{

                                             "stockLocationAssignment": {
                                    

"stockLocationAssignmentId

StockLocationAssignmentId

Stock location assignment identifier

": "{Integer}",

"status

Status

Status of stock location assignment

Possible domain values can be found here

": "{Integer}",

"createdAt

CreatedAt

Date and time of creation

": "{Datetime}",

"quantity

Quantity

Initial quantity placed in the stock location

": "{Decimal}",

"remainingQuantity

RemainingQuantity

Quantity from goods reception item remaining in stock location

": "{Decimal}",

"isBlockedForPicking

IsBlockedForPicking

True if picking from this stock location is not allowed

": "{Boolean}",

"isBlockedForStockAssignments

IsBlockedForStockAssignments

True if block linking

": "{Boolean}",

"containsSecondHandProducts

ContainsSecondHandProducts

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

": "{Boolean}",

"containsSparepartsUsedForRepair

ContainsSparepartsUsedForRepair

True if location contains spareparts used for repair.

": "{Boolean}",

"manufacturersProduct

ManufacturersProduct

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

": {

"manufacturersProductId

ManufacturersProductId

Manufacturer product identifier

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

": "{Integer}",

"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=ManufacturersProduct in your request URI to get this field

": "{String}",

"manufacturersProductLink

ManufacturersProductLink

Manufacturers product reference

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

": "{String}"

},

                                                  "goodsReceptionItem": {
                                    

"goodsReceptionItemId

GoodsReceptionItemId

Item-/line-number of the goods reception

": "{Integer}",

"database

Database

Company code/database the object belongs to

": "{String}",

                                                       "goodsReception": {
                                    

"goodsReceptionId

GoodsReceptionId

Goods reception identifier

": "{Integer}",

"goodsReceptionLink

GoodsReceptionLink

Goods reception identifier

": "{String}"

},

                                                       "product": {
                                    

"productId

ProductId

Assignment register identifier

": "{Integer}",

"name

Name

Name of the product

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

": "{String}",

"description

Description

Description of the product

": "{String}",

"productLink

ProductLink

Product reference

": "{String}"

},

                                                       "stockAssignment": {
                                    

"stockAssignmentId

StockAssignmentId

Assignment register identifier

": "{Integer}",

"stockAssignmentLink

StockAssignmentLink

Assignment register reference

": "{String}"

},

"goodsReceptionItemLink

GoodsReceptionItemLink

Goods reception item reference

": "{String}"

},

                                                  "stockLocation": {
                                    

"stockLocationId

StockLocationId

Stock location identifier

": "{Integer}",

"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=StockLocation.Label in your request URI to get this field

": "{String}",

"isBlockedForStock

IsBlockedForStock

Determines whether or not this stock location is blocked for stock

": "{Boolean}",

                                                       "location": {
                                    

"locationId

LocationId

Location identifier

": "{Integer}",

"locationLink

LocationLink

Location reference

": "{String}"

},

"stockLocationLink

StockLocationLink

Stock location reference

": "{String}"

}

}

}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

POST

Print blocket sheet

AOP/100993

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