Logistics APIs
List of items for provided goods reception
| HTTP method | GET |
| URI | https://api.rambase.net/logistics/goods-receptions/{goodsReceptionId}/items |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {goodsReceptionId} |
Goods reception identifier
Integer, minimum 10000 |
| Maximum page size ($top) | 80 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 3334, version 31 |
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.
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" |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
| $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.
| IsWarehouseOperator() Named filter | Goods reception items belonging to my warehouse operator group |
| AvailableQuantity Decimal | Quantity available/free for use. Not assigned to anything. |
| BestBeforeDate Date | Goods received in this goods reception item is best before this date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| GoodsReceptionItemId Integer | Item-/line-number of the goods reception. |
| HeatNumber String | A heat number is an identification coupon number that is stamped on a material plate after it is removed from the ladle and rolled at a steel mill. |
| LineNumber Integer | Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc. |
| ManufacturerShortName String | Shortname/code of the manufacturer. |
| Name String | Name of the product. |
| NetAmount Decimal | Final item amount after deducting all discounts etc. |
| NetPrice Decimal | Final price per unit after deducting all discounts etc. |
| Note String | Additional information regarding the item (free text). Might be visible to customers/suppliers. |
| ProductDescription String | Description of the item. If not specified, the description is by default copied from the product. |
| ProductId Integer | Product identifier. |
| ProductionLot String | The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch. |
| ProductType String | Type of product. |
| Quantity Decimal | Number of units received. |
| RemainingQuantity Decimal | Remaining number of units to be forwarded. |
| ReservedQuantity Decimal | Quantity reserved from beeing assigned to other objects. Ex. quantity reserved to be used as spare parts, reserved for exhibitions and similar. The reserved quantity cannot be assigned to anything until the reservedquantity is released.. |
| Status Integer | Status code of the the goods reception item. |
| StockQuantity Decimal | Remaining quantity in stock of the goods reception item. This quantity will decrease when shipped to customer or supplier, or when consumed in a completed production. |
| SuppliersProductName String | Suppliers internal name of the product. Retrieved from the product. |
| SuppliersReferenceNumber String | Suppliers/sellers item reference number. Typically to an external system. |
| WarehouseGroupId Integer | Warehouse operators group identifier. |
Read more about filters and sorting on how to use sortable parameters
| AvailableQuantity Decimal | Quantity available/free for use. Not assigned to anything. |
| BestBeforeDate Date | Goods received in this goods reception item is best before this date. |
| CreatedAt Datetime | Date and time of creation |
| GoodsReceptionItemId Integer | Item-/line-number of the goods reception |
| HeatNumber String | A heat number is an identification coupon number that is stamped on a material plate after it is removed from the ladle and rolled at a steel mill. |
| LineNumber Integer | Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc. |
| ManufacturerShortName String | Shortname/code of the manufacturer |
| Name String | Name of the product |
| NetAmount Decimal | Final item amount after deducting all discounts etc. |
| NetPrice Decimal | Final price per unit after deducting all discounts etc. |
| Note String | Additional information regarding the item (free text). Might be visible to customers/suppliers. |
| ProductDescription String | Description of the item. If not specified, the description is by default copied from the product. |
| ProductId Integer | Product identifier |
| ProductionLot String | The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch. |
| ProductType String | Type of product |
| Quantity Decimal | Number of units received |
| RemainingQuantity Decimal | Remaining number of units to be forwarded |
| ReservedQuantity Decimal | Quantity reserved from beeing assigned to other objects. Ex. quantity reserved to be used as spare parts, reserved for exhibitions and similar. The reserved quantity cannot be assigned to anything until the reservedquantity is released. |
| Status Integer | Status code of the the goods reception item |
| StockQuantity Decimal | Remaining quantity in stock of the goods reception item. This quantity will decrease when shipped to customer or supplier, or when consumed in a completed production. |
| SuppliersProductName String | Suppliers internal name of the product. Retrieved from the product. |
| SuppliersReferenceNumber String | Suppliers/sellers item reference number. Typically to an external system. |
| WarehouseGroupId Integer | Warehouse operators group identifier |
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.
GoodsReceptionItemId
Item-/line-number of the goods reception
>{Integer}</GoodsReceptionItemId>Status
Status code of the the goods reception item
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>LineNumber
Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
>{Integer}</LineNumber>SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
>{String}</SuppliersReferenceNumber>SuppliersProductName
Suppliers internal name of the product. Retrieved from the product.
>{String}</SuppliersProductName>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
>{String}</ProductDescription>Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
>{String}</Note>Quantity
Number of units received
>{Decimal}</Quantity>NotInvoicedQuantity
Remaining quantity that has not been invoiced. Will decrease when the goods reception get invoiced. Note that goods receptions can get invoiced for none or part of the items.
>{Decimal}</NotInvoicedQuantity>AvailableQuantity
Quantity available/free for use. Not assigned to anything.
>{Decimal}</AvailableQuantity>StockQuantity
Remaining quantity in stock of the goods reception item. This quantity will decrease when shipped to customer or supplier, or when consumed in a completed production.
>{Decimal}</StockQuantity>RemainingQuantity
Remaining number of units to be forwarded
>{Decimal}</RemainingQuantity>ReservedQuantity
Quantity reserved from beeing assigned to other objects. Ex. quantity reserved to be used as spare parts, reserved for exhibitions and similar. The reserved quantity cannot be assigned to anything until the reservedquantity is released.
>{Decimal}</ReservedQuantity>HeatNumber
A heat number is an identification coupon number that is stamped on a material plate after it is removed from the ladle and rolled at a steel mill.
>{String}</HeatNumber>ProductionLot
The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch.
>{String}</ProductionLot>ProductionDate
Production date is the date when the product was manufactured. For purchased products this date is informed about from supplier. For goods that are manufactured inhouse, this date is a date for when the company manufactured these products.
>{Date}</ProductionDate>CountryOfOriginCode
Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.
>{String}</CountryOfOriginCode>BestBeforeDate
Goods received in this goods reception item is best before this date.
>{Date}</BestBeforeDate>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetPrice
Final price per unit after deducting all discounts etc.
>{Decimal}</NetPrice>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetAmount
Final item amount after deducting all discounts etc.
>{Decimal}</NetAmount>MeasurementUnitId
Measurement unit identifier
>{Integer}</MeasurementUnitId>Unit
Measurement unit (ex. mm, km, dl, kg)
>{String}</Unit>MeasurementUnitLink
Material unit reference
>{String}</MeasurementUnitLink>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>ManufacturerId
Manufacturer identifier
>{Integer}</ManufacturerId>ShortName
Shortname/code of the manufacturer
>{String}</ShortName>ManufacturerLink
Manufacturer reference
>{String}</ManufacturerLink>GoodsReceptionItemLink
Goods reception item reference
>{String}</GoodsReceptionItemLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>GoodsReceptionItemId
Item-/line-number of the goods reception
": "{Integer}",Status
Status code of the the goods reception item
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",LineNumber
Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
": "{Integer}",SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
": "{String}",SuppliersProductName
Suppliers internal name of the product. Retrieved from the product.
": "{String}",ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
": "{String}",Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
": "{String}",Quantity
Number of units received
": "{Decimal}",NotInvoicedQuantity
Remaining quantity that has not been invoiced. Will decrease when the goods reception get invoiced. Note that goods receptions can get invoiced for none or part of the items.
": "{Decimal}",AvailableQuantity
Quantity available/free for use. Not assigned to anything.
": "{Decimal}",StockQuantity
Remaining quantity in stock of the goods reception item. This quantity will decrease when shipped to customer or supplier, or when consumed in a completed production.
": "{Decimal}",RemainingQuantity
Remaining number of units to be forwarded
": "{Decimal}",ReservedQuantity
Quantity reserved from beeing assigned to other objects. Ex. quantity reserved to be used as spare parts, reserved for exhibitions and similar. The reserved quantity cannot be assigned to anything until the reservedquantity is released.
": "{Decimal}",HeatNumber
A heat number is an identification coupon number that is stamped on a material plate after it is removed from the ladle and rolled at a steel mill.
": "{String}",ProductionLot
The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch.
": "{String}",ProductionDate
Production date is the date when the product was manufactured. For purchased products this date is informed about from supplier. For goods that are manufactured inhouse, this date is a date for when the company manufactured these products.
": "{Date}",CountryOfOriginCode
Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.
": "{String}",BestBeforeDate
Goods received in this goods reception item is best before this date.
": "{Date}",Currency
Three character code following the ISO 4217 standard
": "{String}",NetPrice
Final price per unit after deducting all discounts etc.
": "{Decimal}"Currency
Three character code following the ISO 4217 standard
": "{String}",NetAmount
Final item amount after deducting all discounts etc.
": "{Decimal}"MeasurementUnitId
Measurement unit identifier
": "{Integer}",Unit
Measurement unit (ex. mm, km, dl, kg)
": "{String}",MeasurementUnitLink
Material unit reference
": "{String}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",ProductLink
Product reference
": "{String}"ManufacturerId
Manufacturer identifier
": "{Integer}",ShortName
Shortname/code of the manufacturer
": "{String}",ManufacturerLink
Manufacturer reference
": "{String}"GoodsReceptionItemLink
Goods reception item reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 100147 HTTP 404 | Notification type not found |
| Error 101420 HTTP 404 | Setting definition not found |