Sales APIs
Retrieve a specific item price agreement
| HTTP method | GET |
| URI | https://api.rambase.net/sales/item-price-agreements/{itemPriceAgreementId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {itemPriceAgreementId} |
Item price agreement identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 2448, version 10 |
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.
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.
| $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] |
| $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 |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $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. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
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. Fields colored in grey is expandable 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 100204 HTTP 404 | Manufacturer not found |