Logistics APIs
Creates a new item in provided goods reception
| HTTP method | POST |
| 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 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 3363, version 6 |
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.
SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
This field is optional.
>{String}</SuppliersReferenceNumber>SuppliersProductName
Suppliers internal name of the product. Retrieved from the product.
This field is optional.
>{String}</SuppliersProductName>EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
This field is optional.
>{String}</EquivalentProductName>ProductStructureRevision
The requested revision of the product structure
This field is optional.
>{String}</ProductStructureRevision>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
This field is optional.
>{String}</ProductDescription>Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
This field is optional.
>{String}</Note>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.
This field is optional.
>{String}</HeatNumber>Parcels
Number of parcels/packages for this reception item. Used for deciding number of labels to print.
This field is optional.
>{Integer}</Parcels>Quantity
Required/mandatory field
Number of units received
Minimum value: 0
>{Decimal}</Quantity>ProductionLot
The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch.
This field is optional.
>{String}</ProductionLot>Price
This field is optional.
>NetPrice
Final price per unit after deducting all discounts etc.
Minimum value: 0
This field is optional.
>{Decimal}</NetPrice>Freight
Freight pr unit. Is a part of landed cost for the received product.
Minimum value: 0
This field is optional.
>{Decimal}</Freight>FreightPercent
Freight in percent of net price. Used for including freight cost in the gross margin calculation in sales orders, sales invoices etc.
Minimum value: 0
Maximum value: 100
This field is optional.
>{Decimal}</FreightPercent>ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
>{Integer}</ProductId>SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
This field is optional.
": "{String}",SuppliersProductName
Suppliers internal name of the product. Retrieved from the product.
This field is optional.
": "{String}",EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
This field is optional.
": "{String}",ProductStructureRevision
The requested revision of the product structure
This field is optional.
": "{String}",ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
This field is optional.
": "{String}",Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
This field is optional.
": "{String}",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.
This field is optional.
": "{String}",Parcels
Number of parcels/packages for this reception item. Used for deciding number of labels to print.
This field is optional.
": "{Integer}",Quantity
Required/mandatory field
Number of units received
Minimum value: 0
": "{Decimal}",ProductionLot
The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch.
This field is optional.
": "{String}",Price
This field is optional.
": {NetPrice
Final price per unit after deducting all discounts etc.
Minimum value: 0
This field is optional.
": "{Decimal}",Freight
Freight pr unit. Is a part of landed cost for the received product.
Minimum value: 0
This field is optional.
": "{Decimal}",FreightPercent
Freight in percent of net price. Used for including freight cost in the gross margin calculation in sales orders, sales invoices etc.
Minimum value: 0
Maximum value: 100
This field is optional.
": "{Decimal}"ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
": "{Integer}"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. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
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.
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 100178 HTTP 404 | Dimension not found |
| Error 104192 HTTP 404 | Custom value not found |
| Error 105251 HTTP 400 | Setup time on product structure operation must be greater than 0 |
| Error 105250 HTTP 400 | Cleanup time on product structure operation must be greater than 0 |
| Error 105679 HTTP 400 | Production resource does not allow to add manhours |
| Error 108137 HTTP 400 | Standard ManhourRate is not set for Resource |
| Error 101401 HTTP 400 | The Ship and debit purchase quote must be in the same database as the stock assignment |
| Error 101047 HTTP 400 | The purchase quote item has too low available quantity |
| Error 101400 HTTP 400 | Supplier credit claim has been created from shipping advice |
| Error 102483 HTTP 400 | Finance project is required for general ledger account {0} |
| Error 102484 HTTP 400 | Asset is required for general ledger account {0} |
| Error 102485 HTTP 400 | Dimension {0} ({1}) is required for general ledger account {2} |
| Error 101313 HTTP 400 | Department number is not valid: {0} |
| Error 101320 HTTP 400 | The project number is not valid: {0} |
| Error 101500 HTTP 400 | Project {0} could not be used : Check project FromPeriod and ToPeriod. |
| Error 101501 HTTP 400 | Asset is not allowed on general ledger account {0} |
| Error 101326 HTTP 400 | The asset number is not valid : {0} |
| Error 109539 HTTP 400 | Dimension value {0} could not be used : Check its FromPeriod and ToPeriod. |
| Error 102486 HTTP 400 | Invalid value for dimension {0} |