Sales APIs
Create new item price agreement
| HTTP method | POST |
| URI | https://api.rambase.net/sales/item-price-agreements |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 2480, version 7 |
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.
Title
Required/mandatory field
Title/name of the item price agreement
>{String}</Title>Description
Description of the item price agreement
This field is optional.
>{String}</Description>ExtractDiscount
The discount/surcharge is by default included in the grossprice of the item. If you choose to extract the discount from the price, the discount will be extracted/seperated from the grossprice and shown as a discount in the item. Note that surcharges is always included in the grossprice, and will not show as a discount even if this field is set.
Default value: False
This field is optional.
>{Boolean}</ExtractDiscount>MinimumQuantity
Minimum quantity for this agreement to be valid
Minimum value: 0
Default value: 1
This field is optional.
>{Decimal}</MinimumQuantity>StackPriority
If value is set, agreement is stackable. The stack priority specifies the order of the calculation, and is unique across all item price agreements. Agreement will be calculated in descendent order (highest stacking priority first).
Minimum value: 0
This field is optional.
>{Integer}</StackPriority>Validity
This field is optional.
>EffectiveAt
The date the agreement takes effect. The agreement will be effective from from and including this date.
This field is optional.
>{Datetime}</EffectiveAt>ExpireAt
The date the agreement expires. The agreement will be active to and including this date.
This field is optional.
>{Datetime}</ExpireAt>AppliesTo
Who this item price agreement applies to. Can be empty (all), customer or customer group.
This field is optional.
>ObjectType
Type of object
This field is optional.
>{String}</ObjectType>ObjectId
Identifier of the object
This field is optional.
>{Integer}</ObjectId>AppliesFor
Which product, product group or product-classification this item price agreement applies for. Can also be blank to apply for all products.
This field is optional.
>ObjectType
Type of object
This field is optional.
>{String}</ObjectType>ObjectId
Identifier of the object
This field is optional.
>{String}</ObjectId>AppliesForManufacturer
Which manufacturer this item price agreement applies for. Can also be blank to apply for all manufacturers.
This field is optional.
>ManufacturerId
Manufacturer identifier
Minimum value: 1000
This field is optional.
>{Integer}</ManufacturerId>PriceRoundingRuleset
This field is optional.
>PriceRoundingRulesetId
Price rounding ruleset identifier
Minimum value: 100000
This field is optional.
>{Integer}</PriceRoundingRulesetId>FormulaDefinition
This field is optional.
>FormulaDefinitionId
Formula identifier
Minimum value: 100000
This field is optional.
>{Integer}</FormulaDefinitionId>Title
Required/mandatory field
Title/name of the item price agreement
": "{String}",Description
Description of the item price agreement
This field is optional.
": "{String}",ExtractDiscount
The discount/surcharge is by default included in the grossprice of the item. If you choose to extract the discount from the price, the discount will be extracted/seperated from the grossprice and shown as a discount in the item. Note that surcharges is always included in the grossprice, and will not show as a discount even if this field is set.
Default value: False
This field is optional.
": "{Boolean}",MinimumQuantity
Minimum quantity for this agreement to be valid
Minimum value: 0
Default value: 1
This field is optional.
": "{Decimal}",StackPriority
If value is set, agreement is stackable. The stack priority specifies the order of the calculation, and is unique across all item price agreements. Agreement will be calculated in descendent order (highest stacking priority first).
Minimum value: 0
This field is optional.
": "{Integer}",Validity
This field is optional.
": {EffectiveAt
The date the agreement takes effect. The agreement will be effective from from and including this date.
This field is optional.
": "{Datetime}",ExpireAt
The date the agreement expires. The agreement will be active to and including this date.
This field is optional.
": "{Datetime}"AppliesTo
Who this item price agreement applies to. Can be empty (all), customer or customer group.
This field is optional.
": {ObjectType
Type of object
This field is optional.
": "{String}",ObjectId
Identifier of the object
This field is optional.
": "{Integer}"AppliesFor
Which product, product group or product-classification this item price agreement applies for. Can also be blank to apply for all products.
This field is optional.
": {ObjectType
Type of object
This field is optional.
": "{String}",ObjectId
Identifier of the object
This field is optional.
": "{String}"AppliesForManufacturer
Which manufacturer this item price agreement applies for. Can also be blank to apply for all manufacturers.
This field is optional.
": {ManufacturerId
Manufacturer identifier
Minimum value: 1000
This field is optional.
": "{Integer}"PriceRoundingRuleset
This field is optional.
": {PriceRoundingRulesetId
Price rounding ruleset identifier
Minimum value: 100000
This field is optional.
": "{Integer}"FormulaDefinition
This field is optional.
": {FormulaDefinitionId
Formula identifier
Minimum value: 100000
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.
ItemPriceAgreementId
Item price agreement identifier
>{Integer}</ItemPriceAgreementId>Status
Status of the item price agreement
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Title
Title/name of the item price agreement
>{String}</Title>Description
Description of the item price agreement
>{String}</Description>ExtractDiscount
The discount/surcharge is by default included in the grossprice of the item. If you choose to extract the discount from the price, the discount will be extracted/seperated from the grossprice and shown as a discount in the item. Note that surcharges is always included in the grossprice, and will not show as a discount even if this field is set.
>{Boolean}</ExtractDiscount>MinimumQuantity
Minimum quantity for this agreement to be valid
>{Decimal}</MinimumQuantity>StackPriority
If value is set, agreement is stackable. The stack priority specifies the order of the calculation, and is unique across all item price agreements. Agreement will be calculated in descendent order (highest stacking priority first).
>{Integer}</StackPriority>EffectiveAt
The date the agreement takes effect. The agreement will be effective from from and including this date.
>{Datetime}</EffectiveAt>ExpireAt
The date the agreement expires. The agreement will be active to and including this date.
>{Datetime}</ExpireAt>AppliesTo
Who this item price agreement applies to. Can be empty (all), customer or customer group.
>ObjectType
Type of object
>{String}</ObjectType>ObjectId
Identifier of the object
>{Integer}</ObjectId>Name
Name of customer or customer group
>{String}</Name>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ObjectLink
API reference to the object
>{String}</ObjectLink>AppliesFor
Which product, product group or product-classification this item price agreement applies for. Can also be blank to apply for all products.
>ObjectType
Type of object
>{String}</ObjectType>ObjectId
Identifier of the object
>{String}</ObjectId>Name
Name of product, product group or product classification
>{String}</Name>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ObjectLink
API reference to the object
>{String}</ObjectLink>AppliesForManufacturer
Which manufacturer this item price agreement applies for. Can also be blank to apply for all manufacturers.
>ManufacturerId
Manufacturer identifier
>{Integer}</ManufacturerId>ShortName
Shortname/code of the manufacturer
>{String}</ShortName>ManufacturerLink
Manufacturer reference
>{String}</ManufacturerLink>PriceRoundingRulesetId
Price rounding ruleset identifier
>{Integer}</PriceRoundingRulesetId>Name
Name/title of price rounding ruleset
>{String}</Name>PriceRoundingRulesetLink
Price rounding ruleset reference
>{String}</PriceRoundingRulesetLink>FormulaDefinitionId
Formula identifier
>{Integer}</FormulaDefinitionId>Title
Title of the formula
>{String}</Title>TranslatedTitle
Title translated to selected language. If no translation exists, the english title will show
>{String}</TranslatedTitle>FormulaDefinitionLink
Formula reference
>{String}</FormulaDefinitionLink>ItemPriceAgreementId
Item price agreement identifier
": "{Integer}",Status
Status of the item price agreement
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Title
Title/name of the item price agreement
": "{String}",Description
Description of the item price agreement
": "{String}",ExtractDiscount
The discount/surcharge is by default included in the grossprice of the item. If you choose to extract the discount from the price, the discount will be extracted/seperated from the grossprice and shown as a discount in the item. Note that surcharges is always included in the grossprice, and will not show as a discount even if this field is set.
": "{Boolean}",MinimumQuantity
Minimum quantity for this agreement to be valid
": "{Decimal}",StackPriority
If value is set, agreement is stackable. The stack priority specifies the order of the calculation, and is unique across all item price agreements. Agreement will be calculated in descendent order (highest stacking priority first).
": "{Integer}",EffectiveAt
The date the agreement takes effect. The agreement will be effective from from and including this date.
": "{Datetime}",ExpireAt
The date the agreement expires. The agreement will be active to and including this date.
": "{Datetime}"AppliesTo
Who this item price agreement applies to. Can be empty (all), customer or customer group.
": {ObjectType
Type of object
": "{String}",ObjectId
Identifier of the object
": "{Integer}",Name
Name of customer or customer group
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ObjectLink
API reference to the object
": "{String}"AppliesFor
Which product, product group or product-classification this item price agreement applies for. Can also be blank to apply for all products.
": {ObjectType
Type of object
": "{String}",ObjectId
Identifier of the object
": "{String}",Name
Name of product, product group or product classification
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ObjectLink
API reference to the object
": "{String}"AppliesForManufacturer
Which manufacturer this item price agreement applies for. Can also be blank to apply for all manufacturers.
": {ManufacturerId
Manufacturer identifier
": "{Integer}",ShortName
Shortname/code of the manufacturer
": "{String}",ManufacturerLink
Manufacturer reference
": "{String}"PriceRoundingRulesetId
Price rounding ruleset identifier
": "{Integer}",Name
Name/title of price rounding ruleset
": "{String}",PriceRoundingRulesetLink
Price rounding ruleset reference
": "{String}"FormulaDefinitionId
Formula identifier
": "{Integer}",Title
Title of the formula
": "{String}",TranslatedTitle
Title translated to selected language. If no translation exists, the english title will show
": "{String}",FormulaDefinitionLink
Formula 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 102738 HTTP 404 | Price list not found |
| Error 100055 HTTP 403 | You have only admittance to your own objects |
| Error 102773 HTTP 404 | Object not found |
| Error 102777 HTTP 400 | Formula definition is not activated |
| Error 102878 HTTP 400 | The selected formula is not a price formula |
| Error 102778 HTTP 400 | Price rounding ruleset is not activated |
| Error 102779 HTTP 400 | Start of period must be less or equal to end of period |
| Error 102812 HTTP 400 | Effective at cannot be in the past |
| Error 102843 HTTP 400 | Expire at can not be in the past |
| Error 102774 HTTP 400 | This stack priority is already used |