Sales APIs

GET sales/item-price-agreements

Retrieve a list of item price agreements

HTTP method	GET
URI	https://api.rambase.net/sales/item-price-agreements
Supported formats	Xml, Html, Json (ex. $format=json)
Maximum page size ($top)	80
Successful HTTP status code	200
API resource identifier	2481, version 14

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.

Format:

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
$expand String, optional	Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select 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.
$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.
$format String, optional	Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional	Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional	Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional	Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional	Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional	Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

Active() Named filter	Active item price agreements
ActiveAndNew() Named filter	Active and new item price agreements
Deactivated() Named filter	Deactivated item price agreements
Stackable() Named filter	Stackable item price agreements
AppliesForId Integer	Identifier of the object.
AppliesForManufacturerId Integer	Manufacturer identifier.
AppliesForObjectType String	Type of object.
AppliesToId Integer	Identifier of the object.
AppliesToObjectType String	Type of object.
CreatedAt Datetime	Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Description String	Description of the item price agreement.
EffectiveAt Datetime	The date the agreement takes effect. The agreement will be effective from from and including this date. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ExpireAt Datetime	The date the agreement expires. The agreement will be active to and including this date. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ExtractDiscount Boolean	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.
FormulaDefinitionId Integer	Formula identifier.
ItemPriceAgreementId Integer	Item price agreement identifier.
MinimumQuantity Decimal	Minimum quantity for this agreement to be valid.
StackPriority Integer	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).
Status Integer	Status of the item price agreement.
Title String	Title/name of the item price agreement.
UpdatedAt Datetime	Date and time of update. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()

Read more about filters and sorting on how to use sortable parameters

AppliesForId Integer	Identifier of the object
AppliesForManufacturerId Integer	Manufacturer identifier
AppliesForObjectType String	Type of object
AppliesToId Integer	Identifier of the object
AppliesToObjectType String	Type of object
CreatedAt Datetime	Date and time of creation
Description String	Description of the item price agreement
EffectiveAt Datetime	The date the agreement takes effect. The agreement will be effective from from and including this date.
ExpireAt Datetime	The date the agreement expires. The agreement will be active to and including this date.
ExtractDiscount Boolean	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.
FormulaDefinitionId Integer	Formula identifier
ItemPriceAgreementId Integer	Item price agreement identifier
MinimumQuantity Decimal	Minimum quantity for this agreement to be valid
StackPriority Integer	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).
Status Integer	Status of the item price agreement
Title String	Title/name of the item price agreement
UpdatedAt Datetime	Date and time of update

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.

Format:

                                        <ItemPriceAgreements>
                                    

                                             <ItemPriceAgreement>
                                    

<ItemPriceAgreementId

ItemPriceAgreementId

Item price agreement identifier

>{Integer}</ItemPriceAgreementId>

<Status

Status

Status of the item price agreement

Possible domain values can be found here

>{Integer}</Status>

<CreatedAt

CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>

<Title

Title

Title/name of the item price agreement

>{String}</Title>

<Description

Description

Description of the item price agreement

>{String}</Description>

<MinimumQuantity

MinimumQuantity

Minimum quantity for this agreement to be valid

>{Decimal}</MinimumQuantity>

<StackPriority

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>

                                                  <Validity>
                                    

<EffectiveAt

EffectiveAt

The date the agreement takes effect. The agreement will be effective from from and including this date.

>{Datetime}</EffectiveAt>

<ExpireAt

ExpireAt

The date the agreement expires. The agreement will be active to and including this date.

>{Datetime}</ExpireAt>

                                                  </Validity>
                                    

<AppliesTo

AppliesTo

Who this item price agreement applies to. Can be empty (all), customer or customer group.

<ObjectType

ObjectType

Type of object

>{String}</ObjectType>

<ObjectId

ObjectId

Identifier of the object

>{Integer}</ObjectId>

<Name

Name

Name of customer or customer group

This field is greyed out because it is an expandable field. You have to add $expand=ItemPriceAgreement.AppliesTo.Name in your request URI to get this field

>{String}</Name>

<RamBaseKey

RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>

<ObjectLink

ObjectLink

API reference to the object

>{String}</ObjectLink>

                                                  </AppliesTo>
                                    

<AppliesFor

AppliesFor

Which product, product group or product-classification this item price agreement applies for. Can also be blank to apply for all products.

<ObjectType

ObjectType

Type of object

>{String}</ObjectType>

<ObjectId

ObjectId

Identifier of the object

>{String}</ObjectId>

<Name

Name

Name of product, product group or product classification

This field is greyed out because it is an expandable field. You have to add $expand=ItemPriceAgreement.AppliesFor.Name in your request URI to get this field

>{String}</Name>

<RamBaseKey

RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>

<ObjectLink

ObjectLink

API reference to the object

>{String}</ObjectLink>

                                                  </AppliesFor>
                                    

<AppliesForManufacturer

AppliesForManufacturer

Which manufacturer this item price agreement applies for. Can also be blank to apply for all manufacturers.

<ManufacturerId

ManufacturerId

Manufacturer identifier

>{Integer}</ManufacturerId>

<ShortName

ShortName

Shortname/code of the manufacturer

>{String}</ShortName>

<ManufacturerLink

ManufacturerLink

Manufacturer reference

>{String}</ManufacturerLink>

                                                  </AppliesForManufacturer>
                                    

                                                  <FormulaDefinition>
                                    

<FormulaDefinitionId

FormulaDefinitionId

Formula identifier

>{Integer}</FormulaDefinitionId>

<FormulaDefinitionLink

FormulaDefinitionLink

Formula reference

>{String}</FormulaDefinitionLink>

                                                  </FormulaDefinition>
                                    

<ItemPriceAgreementLink

ItemPriceAgreementLink

Item price agreement reference

>{String}</ItemPriceAgreementLink>

                                             </ItemPriceAgreement>
                                    

<Paging

Paging

Detailed paging information for this list.

<PageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>

<Position

Position

Position of the first element in the list

>{Integer}</Position>

<Page

Page

Page index

>{Integer}</Page>

<FirstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>

<FirstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>

<PreviousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>

<PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>

<NextPageKey

NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>

<NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>

<LastPageKey

LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>

<LastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>

<Size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>

                                             </Paging>
                                    

                                        </ItemPriceAgreements>
                                    

{

                                             "itemPriceAgreements": [
                                    

{

"itemPriceAgreementId

ItemPriceAgreementId

Item price agreement identifier

": "{Integer}",

"status

Status

Status of the item price agreement

Possible domain values can be found here

": "{Integer}",

"createdAt

CreatedAt

Date and time of creation

": "{Datetime}",

"title

Title

Title/name of the item price agreement

": "{String}",

"description

Description

Description of the item price agreement

": "{String}",

"minimumQuantity

MinimumQuantity

Minimum quantity for this agreement to be valid

": "{Decimal}",

"stackPriority

StackPriority

": "{Integer}",

                                                       "validity": {
                                    

"effectiveAt

EffectiveAt

The date the agreement takes effect. The agreement will be effective from from and including this date.

": "{Datetime}",

"expireAt

ExpireAt

The date the agreement expires. The agreement will be active to and including this date.

": "{Datetime}"

},

"appliesTo

AppliesTo

Who this item price agreement applies to. Can be empty (all), customer or customer group.

": {

"objectType

ObjectType

Type of object

": "{String}",

"objectId

ObjectId

Identifier of the object

": "{Integer}",

"name

Name

Name of customer or customer group

This field is greyed out because it is an expandable field. You have to add $expand=ItemPriceAgreement.AppliesTo.Name in your request URI to get this field

": "{String}",

"ramBaseKey

RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",

"objectLink

ObjectLink

API reference to the object

": "{String}"

},

"appliesFor

AppliesFor

Which product, product group or product-classification this item price agreement applies for. Can also be blank to apply for all products.

": {

"objectType

ObjectType

Type of object

": "{String}",

"objectId

ObjectId

Identifier of the object

": "{String}",

"name

Name

Name of product, product group or product classification

This field is greyed out because it is an expandable field. You have to add $expand=ItemPriceAgreement.AppliesFor.Name in your request URI to get this field

": "{String}",

"ramBaseKey

RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",

"objectLink

ObjectLink

API reference to the object

": "{String}"

},

"appliesForManufacturer

AppliesForManufacturer

Which manufacturer this item price agreement applies for. Can also be blank to apply for all manufacturers.

": {

"manufacturerId

ManufacturerId

Manufacturer identifier

": "{Integer}",

"shortName

ShortName

Shortname/code of the manufacturer

": "{String}",

"manufacturerLink

ManufacturerLink

Manufacturer reference

": "{String}"

},

                                                       "formulaDefinition": {
                                    

"formulaDefinitionId

FormulaDefinitionId

Formula identifier

": "{Integer}",

"formulaDefinitionLink

FormulaDefinitionLink

Formula reference

": "{String}"

},

"itemPriceAgreementLink

ItemPriceAgreementLink

Item price agreement reference

": "{String}"

}

],

"paging

Paging

Detailed paging information for this list.

": {

"pageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",

"position

Position

Position of the first element in the list

": "{Integer}",

"page

Page

Page index

": "{Integer}",

"firstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"firstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",

"previousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"previousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",

"nextPageKey

NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"nextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",

"lastPageKey

LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"lastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",

"size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"

}

}

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
Error 100089 HTTP 404	Product {0} not found