Logistics APIs
Changes a product by removing defined quantity from a goods reception of one product with a stock adjustment, and increasing the quantity of a goods reception of another product. This is an API operation. Read the documentation pages for more information about API operations.
| HTTP method | POST |
| URI | https://api.rambase.net/logistics/goods-receptions/{goodsReceptionId}/items/{itemId}/api-operations/101553/instances |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {goodsReceptionId} |
Goods reception identifier
Integer, minimum 10000 |
| - URI parameter {itemId} |
Item-/line-number of the goods reception
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 5585, version 3 |
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.
SourceStockLocationId
Required/mandatory field
Stock location identifier
Minimum value: 100000
>{Integer}</SourceStockLocationId>DestinationStockLocationId
Stock location identifier
Minimum value: 100000
This field is optional.
>{Integer}</DestinationStockLocationId>RegisterGoodsReceptionToStock
If set to 1 the goods reception will be registered to stock ( Set to status 3 or 9 )
Default value: False
This field is optional.
>{Boolean}</RegisterGoodsReceptionToStock>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
This field is optional.
>{String}</ProductDescription>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>Quantity
Required/mandatory field
Number of units received
Minimum value: 0
>{Decimal}</Quantity>BestBeforeDate
Goods received in this goods reception item is best before this date.
This field is optional.
>{Date}</BestBeforeDate>MaterialQuality
This field is optional.
>QualityCode
Quality of the material. Only used for information.
This field is optional.
>{String}</QualityCode>InternalNote
Additonal quality codes that are covered in addition to the code given by the field Quality description
This field is optional.
>{String}</InternalNote>NetPrice
Required/mandatory field
Final price per unit after deducting all discounts etc.
Minimum value: 0
>{Decimal}</NetPrice>ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
>{Integer}</ProductId>SourceStockLocationId
Required/mandatory field
Stock location identifier
Minimum value: 100000
": "{Integer}",DestinationStockLocationId
Stock location identifier
Minimum value: 100000
This field is optional.
": "{Integer}",RegisterGoodsReceptionToStock
If set to 1 the goods reception will be registered to stock ( Set to status 3 or 9 )
Default value: False
This field is optional.
": "{Boolean}",ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
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}",Quantity
Required/mandatory field
Number of units received
Minimum value: 0
": "{Decimal}",BestBeforeDate
Goods received in this goods reception item is best before this date.
This field is optional.
": "{Date}",MaterialQuality
This field is optional.
": {QualityCode
Quality of the material. Only used for information.
This field is optional.
": "{String}",InternalNote
Additonal quality codes that are covered in addition to the code given by the field Quality description
This field is optional.
": "{String}"NetPrice
Required/mandatory field
Final price per unit after deducting all discounts etc.
Minimum value: 0
": "{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] |
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.
OperationInstanceId
Operation instance identifier
>{Integer}</OperationInstanceId>Status
Status of the instance, 2 = started, 7 = error, 9 = finished
>{Integer}</Status>CreatedAt
Date and time the operation instance was created
>{Datetime}</CreatedAt>CreatedBy
Reference to the creator
>UserId
User identifier
>{Integer}</UserId>UserLink
User reference
>{String}</UserLink>ObjectId
Identifier of the object
>{String}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ItemLink
API reference to the item
>{String}</ItemLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ApiOprationId
Api operation identifiers
>{Integer}</ApiOprationId>ApiOperationLink
Api operation reference
>{String}</ApiOperationLink>ObjectId
Identifier of the object
>{String}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ItemLink
API reference to the item
>{String}</ItemLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>Message
Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).
>{String}</Message>TranslatedMessage
Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.
>{String}</TranslatedMessage>StackTrace
Stack trace for details about the error
>{String}</StackTrace>ErrorMessage
Contains a reference to the error message, if an error occured
>ErrorMessageId
Error message identifier
>{Integer}</ErrorMessageId>ErrorMessageLink
Error message reference
>{String}</ErrorMessageLink>Index
Error Key
>{Integer}</Index>Value
Value of the error parameter
>{String}</Value>Message
Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).
>{String}</Message>TranslatedMessage
Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.
>{String}</TranslatedMessage>StackTrace
Stack trace for details about the error
>{String}</StackTrace>ErrorMessage
Contains a reference to the error message, if an error occured
>ErrorMessageId
Error message identifier
>{Integer}</ErrorMessageId>ErrorMessageLink
Error message reference
>{String}</ErrorMessageLink>Index
Error Key
>{Integer}</Index>Value
Value of the error parameter
>{String}</Value>Key
Key of the result value
>{String}</Key>Value
Value of the result value
>{String}</Value>SystemJob
Contains a reference to the system job, if a system job was started
>ObjectId
{OIN.ObjectId}
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>PercentComplete
Percent complete
>{Integer}</PercentComplete>ObjectLink
API reference to the object
>{String}</ObjectLink>OperationInstanceLink
Operation instance reference
>{String}</OperationInstanceLink>OperationInstanceId
Operation instance identifier
": "{Integer}",Status
Status of the instance, 2 = started, 7 = error, 9 = finished
": "{Integer}",CreatedAt
Date and time the operation instance was created
": "{Datetime}",CreatedBy
Reference to the creator
": {UserId
User identifier
": "{Integer}",UserLink
User reference
": "{String}"ObjectId
Identifier of the object
": "{String}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}",ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",ItemLink
API reference to the item
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}"ApiOprationId
Api operation identifiers
": "{Integer}",ApiOperationLink
Api operation reference
": "{String}"ObjectId
Identifier of the object
": "{String}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}",ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",ItemLink
API reference to the item
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}"Message
Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).
": "{String}",TranslatedMessage
Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.
": "{String}",StackTrace
Stack trace for details about the error
": "{String}",ErrorMessage
Contains a reference to the error message, if an error occured
": {ErrorMessageId
Error message identifier
": "{Integer}",ErrorMessageLink
Error message reference
": "{String}"Index
Error Key
": "{Integer}",Value
Value of the error parameter
": "{String}"Message
Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).
": "{String}",TranslatedMessage
Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.
": "{String}",StackTrace
Stack trace for details about the error
": "{String}",ErrorMessage
Contains a reference to the error message, if an error occured
": {ErrorMessageId
Error message identifier
": "{Integer}",ErrorMessageLink
Error message reference
": "{String}"Index
Error Key
": "{Integer}",Value
Value of the error parameter
": "{String}"Key
Key of the result value
": "{String}",Value
Value of the result value
": "{String}"SystemJob
Contains a reference to the system job, if a system job was started
": {ObjectId
{OIN.ObjectId}
": "{Integer}",ObjectType
Type of object
": "{String}",PercentComplete
Percent complete
": "{Integer}",ObjectLink
API reference to the object
": "{String}"OperationInstanceLink
Operation instance reference
": "{String}"
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 100245 HTTP 404 | Supplier invoice not found. |
| Error 101254 HTTP 400 | Only articles with matching PARTNERID can be purchased from this supplier |
| Error 104869 HTTP 404 | Default account not found |
| Error 101328 HTTP 400 | Not allowed when the goods reception is still pending lable print (status 1) |
| Error 101318 HTTP 400 | The stock location assignment cannot be assigned to a stock location |
| Error 101319 HTTP 400 | The stock location assignment must be assigned to a stock location |
| Error 101331 HTTP 400 | Cannot change reference to stock location or goods reception |
| Error 105820 HTTP 400 | Expected end date should come after start date |
| Error 105784 HTTP 400 | Only subscription products can be added to subscription items |
| Error 106957 HTTP 400 | Only rental or subscription products can be used in recurring contract's lines |
| Error 105760 HTTP 400 | You cannot attach a recurring price to a sales order item |
| Error 106302 HTTP 404 | Product revision not found |
| Error 104521 HTTP 400 | Goods reception can only be added as a content of arriving waybill if the waybill is ready for goods reception process and not processed (status 3 or 5) |
| Error 104522 HTTP 400 | Location in goods reception must be equal to location in arriving waybill |