Sales APIs
Creates a new sales order change request item. Fields not specified in the request body will get values from the changed sales order item.
| HTTP method | POST |
| URI | https://api.rambase.net/sales/order-change-requests/{salesOrderChangeRequestId}/items |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {salesOrderChangeRequestId} |
Sales order change request identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 2635, version 2 |
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.
SalesOrderChangeRequestItem
This field is optional.
>RequestedDeliveryDate
The delivery date as requested by the customer.
This field is optional.
>{Date}</RequestedDeliveryDate>CustomersProductName
Customers internal name of the product. Retrieved from the product.
This field is optional.
>{String}</CustomersProductName>EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
This field is optional.
>{String}</EquivalentProductName>RequestedProductStructureRevision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
This field is optional.
>{String}</RequestedProductStructureRevision>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
This field is optional.
>{String}</ProductDescription>DiscountPercent
The discount in percent for this item.
Minimum value: 0
Maximum value: 100
This field is optional.
>{Decimal}</DiscountPercent>Quantity
Requested quantity. Might be negative if cancelled
Minimum value: 0
This field is optional.
>{Decimal}</Quantity>Price
This field is optional.
>GrossPrice
Represents the price per unit before any discounting is applied.
Minimum value: 0
This field is optional.
>{Decimal}</GrossPrice>Discount
Discount for each unit in the item, in document currency. Will be calculated based on Discount percentage, or can be set manually.
Minimum value: 0
This field is optional.
>{Decimal}</Discount>Product
This field is optional.
>ProductId
Product identifier
This field is optional.
>{Integer}</ProductId>SalesOrderChangeRequestItem
This field is optional.
": {RequestedDeliveryDate
The delivery date as requested by the customer.
This field is optional.
": "{Date}",CustomersProductName
Customers 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}",RequestedProductStructureRevision
The revision will typically be a major change, as opposed to minor changes stored in the version 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}",DiscountPercent
The discount in percent for this item.
Minimum value: 0
Maximum value: 100
This field is optional.
": "{Decimal}",Quantity
Requested quantity. Might be negative if cancelled
Minimum value: 0
This field is optional.
": "{Decimal}",Price
This field is optional.
": {GrossPrice
Represents the price per unit before any discounting is applied.
Minimum value: 0
This field is optional.
": "{Decimal}",Discount
Discount for each unit in the item, in document currency. Will be calculated based on Discount percentage, or can be set manually.
Minimum value: 0
This field is optional.
": "{Decimal}"Product
This field is optional.
": {ProductId
Product identifier
This field is optional.
": "{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. |
| $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] |
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.
SalesOrderChangeRequestItemId
Sales order change request item identifier
>{Integer}</SalesOrderChangeRequestItemId>Status
Status of sales order change request
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>RequestedDeliveryDate
The delivery date as requested by the customer.
>{Date}</RequestedDeliveryDate>CustomersProductName
Customers internal name of the product. Retrieved from the product.
>{String}</CustomersProductName>EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
>{String}</EquivalentProductName>RequestedProductStructureRevision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
>{String}</RequestedProductStructureRevision>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
>{String}</ProductDescription>DiscountPercent
The discount in percent for this item.
>{Decimal}</DiscountPercent>Quantity
Requested quantity. Might be negative if cancelled
>{Decimal}</Quantity>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>GrossPrice
Represents the price per unit before any discounting is applied.
>{Decimal}</GrossPrice>Discount
Discount for each unit in the item, in document currency. Will be calculated based on Discount percentage, or can be set manually.
>{Decimal}</Discount>NetPrice
Final price per unit after deducting all discounts etc.
>{Decimal}</NetPrice>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>ManufacturerId
Manufacturer identifier
>{Integer}</ManufacturerId>ShortName
Shortname/code of the manufacturer
>{String}</ShortName>ManufacturerLink
Manufacturer reference
>{String}</ManufacturerLink>ProductLink
Product reference
>{String}</ProductLink>InitialSalesOrderItem
Reference to the initial/first/original sales order item in the document flow for this item.
>SalesOrderItemId
Sales order item identifier
>{Integer}</SalesOrderItemId>SalesOrderId
Sales order identifier
>{Integer}</SalesOrderId>SalesOrderLink
Sales order reference
>{String}</SalesOrderLink>SalesOrderItemLink
Reference to the sales order item.
>{String}</SalesOrderItemLink>ForwardedToSalesOrderItem
Item this item was forwarded to.
>SalesOrderItemId
Sales order item identifier
>{Integer}</SalesOrderItemId>SalesOrderId
Sales order identifier
>{Integer}</SalesOrderId>SalesOrderLink
Sales order reference
>{String}</SalesOrderLink>SalesOrderItemLink
Reference to the sales order item.
>{String}</SalesOrderItemLink>SalesOrderChangeRequestItemId
Sales order change request item identifier
": "{Integer}",Status
Status of sales order change request
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}",RequestedDeliveryDate
The delivery date as requested by the customer.
": "{Date}",CustomersProductName
Customers internal name of the product. Retrieved from the product.
": "{String}",EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
": "{String}",RequestedProductStructureRevision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
": "{String}",ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
": "{String}",DiscountPercent
The discount in percent for this item.
": "{Decimal}",Quantity
Requested quantity. Might be negative if cancelled
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",GrossPrice
Represents the price per unit before any discounting is applied.
": "{Decimal}",Discount
Discount for each unit in the item, in document currency. Will be calculated based on Discount percentage, or can be set manually.
": "{Decimal}",NetPrice
Final price per unit 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}",ManufacturerId
Manufacturer identifier
": "{Integer}",ShortName
Shortname/code of the manufacturer
": "{String}",ManufacturerLink
Manufacturer reference
": "{String}"ProductLink
Product reference
": "{String}"InitialSalesOrderItem
Reference to the initial/first/original sales order item in the document flow for this item.
": {SalesOrderItemId
Sales order item identifier
": "{Integer}",SalesOrderId
Sales order identifier
": "{Integer}",SalesOrderLink
Sales order reference
": "{String}"SalesOrderItemLink
Reference to the sales order item.
": "{String}"ForwardedToSalesOrderItem
Item this item was forwarded to.
": {SalesOrderItemId
Sales order item identifier
": "{Integer}",SalesOrderId
Sales order identifier
": "{Integer}",SalesOrderLink
Sales order reference
": "{String}"SalesOrderItemLink
Reference to the sales order item.
": "{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 109586 HTTP 400 | Missing argument NO when getting mesurement unit |
| Error 100167 HTTP 404 | Measurement unit not found |
| Error 106562 HTTP 400 | This product is blocked for sale |
| Error 106563 HTTP 400 | This product is blocked for shipping |
| Error 100199 HTTP 404 | Location is not found |
| Error 101490 HTTP 400 | Illegal Account {0}: This account has been blocked for {1}-documents |
| Error 101491 HTTP 400 | Illegal Account {0}: Check the account's FromPeriod and ToPeriod |
| Error 101517 HTTP 400 | Illegal Account {0}: This account require ICTDB. |
| Error 102482 HTTP 400 | Department is required for general ledger account {0} |
| 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} |