Sales APIs
If location and/or currency are not provided, company defaults will be used.
| HTTP method | POST |
| URI | https://api.rambase.net/sales/customers/{customerId}/sales-price-calculations |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {customerId} |
Customer identifier
Integer, minimum 10000 |
| Successful HTTP status code | 200 |
| API resource identifier | 5734, 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.
ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
>{Integer}</ProductId>Quantity
Quantity of the object.
Minimum value: 0
Default value: 1
This field is optional.
>{Decimal}</Quantity>Currency
Three character code following the ISO 4217 standard
This field is optional.
>{String}</Currency>LocationId
Location identifier
Minimum value: 10000
This field is optional.
>{Integer}</LocationId>ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
": "{Integer}",Quantity
Quantity of the object.
Minimum value: 0
Default value: 1
This field is optional.
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
This field is optional.
": "{String}",LocationId
Location identifier
Minimum value: 10000
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.
ProductId
Product identifier
>{Integer}</ProductId>StandardLeadTime
The standard lead time, in number of days, from customer places order to delivery.
>{Integer}</StandardLeadTime>StockQuantity
Quantity on hand. The total number of units that are physically located at all locations at the current time. This includes items already assigned to fulfilling production needs or sales orders. So, this number may differ from the available quantity.
>{Decimal}</StockQuantity>AvailableStockQuantity
Quantity on hand which is not assigned. The total number of the product that are physically located in all warehouse locations and are currently available for new orders or fulfilling production needs
>{Decimal}</AvailableStockQuantity>ProductLink
Product reference
>{String}</ProductLink>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 price
>{Decimal}</Discount>NetPrice
Final price per unit after deducting all discounts etc.
>{Decimal}</NetPrice>BasedOn
Specifies what the lowest price was based on. Could be QUOTE, STANDARD or IPA.
Possible domain values can be found here
>{String}</BasedOn>SuggestedPrice
The suggested price for the product.
>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 price
>{Decimal}</Discount>NetPrice
Final price per unit after deducting all discounts etc.
>{Decimal}</NetPrice>BasedOn
Specifies what the lowest price was based on. Could be QUOTE, STANDARD or IPA.
Possible domain values can be found here
>{String}</BasedOn>LocationId
Location identifier
>{Integer}</LocationId>LocationLink
Location reference
>{String}</LocationLink>StockQuantity
Quantity on hand. The total number of the product that are physically located in this location at the current time. This includes items that are already allocated to fulfilling production needs or sales orders. This number may differ from the available quantity.
>{Decimal}</StockQuantity>AvailableStockQuantity
Quantity on hand which is not allocated. The total number of the product that are physically located in this location and are currently available for use in filling a new order or for purposes such as production or distribution.
>{Decimal}</AvailableStockQuantity>ProductId
Product identifier
": "{Integer}",StandardLeadTime
The standard lead time, in number of days, from customer places order to delivery.
": "{Integer}"StockQuantity
Quantity on hand. The total number of units that are physically located at all locations at the current time. This includes items already assigned to fulfilling production needs or sales orders. So, this number may differ from the available quantity.
": "{Decimal}",AvailableStockQuantity
Quantity on hand which is not assigned. The total number of the product that are physically located in all warehouse locations and are currently available for new orders or fulfilling production needs
": "{Decimal}"ProductLink
Product reference
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",GrossPrice
Represents the price per unit before any discounting is applied.
": "{Decimal}",Discount
Discount price
": "{Decimal}",NetPrice
Final price per unit after deducting all discounts etc.
": "{Decimal}",BasedOn
Specifies what the lowest price was based on. Could be QUOTE, STANDARD or IPA.
Possible domain values can be found here
": "{String}"SuggestedPrice
The suggested price for the product.
": {Currency
Three character code following the ISO 4217 standard
": "{String}",GrossPrice
Represents the price per unit before any discounting is applied.
": "{Decimal}",Discount
Discount price
": "{Decimal}",NetPrice
Final price per unit after deducting all discounts etc.
": "{Decimal}",BasedOn
Specifies what the lowest price was based on. Could be QUOTE, STANDARD or IPA.
Possible domain values can be found here
": "{String}"LocationId
Location identifier
": "{Integer}",LocationLink
Location reference
": "{String}"StockQuantity
Quantity on hand. The total number of the product that are physically located in this location at the current time. This includes items that are already allocated to fulfilling production needs or sales orders. This number may differ from the available quantity.
": "{Decimal}",AvailableStockQuantity
Quantity on hand which is not allocated. The total number of the product that are physically located in this location and are currently available for use in filling a new order or for purposes such as production or distribution.
": "{Decimal}"
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 101013 HTTP 404 | Sub-module not found |
| Error 102704 HTTP 404 | Formula parameter was not found |
| Error 101420 HTTP 404 | Setting definition not found |
| Error 102747 HTTP 400 | Error in formula: {0} |