Sales APIs
Adds a price rounding rule to provided ruleset
| HTTP method | POST |
| URI | https://api.rambase.net/sales/price-rounding-rulesets/{priceRoundingRulesetId}/rules |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {priceRoundingRulesetId} |
Price rounding ruleset identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 2515, 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.
Currency
Required/mandatory field
Currency this price rounding rule is valid for
Applicable domain values can be found here
>{String}</Currency>RoundingType
Required/mandatory field
Type of rounding algorithm to use
Applicable domain values can be found here
>{Integer}</RoundingType>RoundingParameter
Required/mandatory field
Parameter used in the rounding algorithm speicifed in the RoundingTYpe
>{String}</RoundingParameter>MinimumPrice
Rule does not apply for prices lower than this value. Note that if a price match several rules, the one with the highest minimum price is chosen.
This field is optional.
>{Decimal}</MinimumPrice>Currency
Required/mandatory field
Currency this price rounding rule is valid for
Applicable domain values can be found here
": "{String}",RoundingType
Required/mandatory field
Type of rounding algorithm to use
Applicable domain values can be found here
": "{Integer}",RoundingParameter
Required/mandatory field
Parameter used in the rounding algorithm speicifed in the RoundingTYpe
": "{String}",MinimumPrice
Rule does not apply for prices lower than this value. Note that if a price match several rules, the one with the highest minimum price is chosen.
This field is optional.
": "{Decimal}"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.
PriceRoundingRuleId
Price rounding rule identifier
>{Integer}</PriceRoundingRuleId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Currency
Currency this price rounding rule is valid for
Possible domain values can be found here
>{String}</Currency>RoundingType
Type of rounding algorithm to use
Possible domain values can be found here
>{Integer}</RoundingType>RoundingParameter
Parameter used in the rounding algorithm speicifed in the RoundingTYpe
>{String}</RoundingParameter>MinimumPrice
Rule does not apply for prices lower than this value. Note that if a price match several rules, the one with the highest minimum price is chosen.
>{Decimal}</MinimumPrice>PriceRoundingRuleId
Price rounding rule identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Currency
Currency this price rounding rule is valid for
Possible domain values can be found here
": "{String}",RoundingType
Type of rounding algorithm to use
Possible domain values can be found here
": "{Integer}",RoundingParameter
Parameter used in the rounding algorithm speicifed in the RoundingTYpe
": "{String}",MinimumPrice
Rule does not apply for prices lower than this value. Note that if a price match several rules, the one with the highest minimum price is chosen.
": "{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 100563 HTTP 400 | Currency {0} is not supported by the system |
| Error 102729 HTTP 400 | The from value can't be empty |
| Error 102719 HTTP 403 | The minimum price already exists for this currency in an existing rule for this price rounding ruleset |
| Error 102736 HTTP 400 | Rounding parameter is invalid |