API

Sales APIs

GET sales/orders/{salesOrderId}/applicable-accessories?productId={productId}&itemId={itemId}

List of applicable accessories for all items of the sales order. If the sales order is in a status where items cannot be added, this API will return an empty list. Note that if product is specified, applicable accessories for that specific product will show even if the product does not exist in any of the items.

HTTP method GET
URI https://api.rambase.net/sales/orders/{salesOrderId}/applicable-accessories?productId={productId}&itemId={itemId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {salesOrderId} Sales order identifier
Integer, minimum 100000
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5359, 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.

Format:
1
1

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.

productId Integer, optional Product identifier

Minimum: 10000
itemId Integer, optional Sales order item identifier

Minimum: 1
$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.

ProductName String Name of the product.

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

ProductName String Name of the product

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:
1
<ApplicableAccessories>
2
     <ApplicableAccessory>
3
          <Accessory>
4
               <AccessoryId
AccessoryId

Accessory identifier

>{Integer}</AccessoryId>
5
               <Product>
6
                    <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
7
                    <Status
Status

Status of the product

Possible domain values can be found here

>{Integer}</Status>
8
                    <Name
Name

Name of the product

>{String}</Name>
9
                    <Description
Description

Description of the product

>{String}</Description>
10
                    <Stock>
11
                         <StockQuantity
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>
12
                         <AvailableStockQuantity
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>
13
                    </Stock>
14
                    <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
15
               </Product>
16
               <AccessoryLink
AccessoryLink

Accessory reference

>{String}</AccessoryLink>
17
          </Accessory>
18
          <ProductLocation
ProductLocation

When specifying object type and object id, we also have a product location we can show availbable stock quantity from

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

>
19
               <Location
Location

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

>
20
                    <ShortName
ShortName

Unique abbreviation/short name of the location

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

>{String}</ShortName>
21
               </Location>
22
               <Stock
Stock

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

>
23
                    <StockQuantity
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.

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

>{Decimal}</StockQuantity>
24
                    <AvailableStockQuantity
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.

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

>{Decimal}</AvailableStockQuantity>
25
               </Stock>
26
          </ProductLocation>
27
          <LowestPrice
LowestPrice

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

>
28
               <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
29
               <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

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

>{Decimal}</GrossPrice>
30
               <Discount
Discount

Discount price

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

>{Decimal}</Discount>
31
               <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

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

>{Decimal}</NetPrice>
32
               <BasedOn
BasedOn

Specifies what the lowest price was based on. Could be QUOTE, STANDARD or IPA.

Possible domain values can be found here

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

>{String}</BasedOn>
33
               <SalesQuoteItem
SalesQuoteItem

If the price is based on a sales quote, a reference to the related quote will be provided.

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

>
34
                    <SalesQuoteItemId
SalesQuoteItemId

Sales quote item identifier

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

>{Integer}</SalesQuoteItemId>
35
                    <SalesQuote
SalesQuote

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

>
36
                         <SalesQuoteId
SalesQuoteId

Sales quote identifier

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

>{Integer}</SalesQuoteId>
37
                         <SalesQuoteLink
SalesQuoteLink

Sales quote reference

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

>{String}</SalesQuoteLink>
38
                    </SalesQuote>
39
                    <SalesQuoteItemLink
SalesQuoteItemLink

Sales quote item referene

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

>{String}</SalesQuoteItemLink>
40
               </SalesQuoteItem>
41
          </LowestPrice>
42
          <Prices
Prices

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

>
43
               <Price
Price

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

>
44
                    <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
45
                    <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

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

>{Decimal}</GrossPrice>
46
                    <Discount
Discount

Discount price

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

>{Decimal}</Discount>
47
                    <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

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

>{Decimal}</NetPrice>
48
                    <BasedOn
BasedOn

Specifies what the lowest price was based on. Could be QUOTE, STANDARD or IPA.

Possible domain values can be found here

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

>{String}</BasedOn>
49
                    <SalesQuoteItem
SalesQuoteItem

If the price is based on a sales quote, a reference to the related quote will be provided.

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

>
50
                         <SalesQuoteItemId
SalesQuoteItemId

Sales quote item identifier

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

>{Integer}</SalesQuoteItemId>
51
                         <RemainingQuantity
RemainingQuantity

Remaining number of units to be forwarded.

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

>{Decimal}</RemainingQuantity>
52
                         <SalesQuote
SalesQuote

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

>
53
                              <SalesQuoteId
SalesQuoteId

Sales quote identifier

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

>{Integer}</SalesQuoteId>
54
                              <SalesQuoteLink
SalesQuoteLink

Sales quote reference

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

>{String}</SalesQuoteLink>
55
                         </SalesQuote>
56
                         <SalesQuoteItemLink
SalesQuoteItemLink

Sales quote item referene

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

>{String}</SalesQuoteItemLink>
57
                    </SalesQuoteItem>
58
               </Price>
59
          </Prices>
60
     </ApplicableAccessory>
61
     <Paging
Paging

Detailed paging information for this list.

>
62
          <PageSize
PageSize

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

>{Integer}</PageSize>
63
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
64
          <Page
Page

Page index

>{Integer}</Page>
65
          <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>
66
          <FirstPage
FirstPage

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

>{String}</FirstPage>
67
          <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>
68
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
69
          <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>
70
          <NextPage
NextPage

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

>{String}</NextPage>
71
          <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>
72
          <LastPage
LastPage

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

>{String}</LastPage>
73
          <Size
Size

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

>{Integer}</Size>
74
     </Paging>
75
</ApplicableAccessories>
1
{
2
     "applicableAccessories": [
3
          {
4
               "accessory": {
5
                    "accessoryId
AccessoryId

Accessory identifier

": "{Integer}",
6
                    "product": {
7
                         "productId
ProductId

Product identifier

": "{Integer}",
8
                         "status
Status

Status of the product

Possible domain values can be found here

": "{Integer}",
9
                         "name
Name

Name of the product

": "{String}",
10
                         "description
Description

Description of the product

": "{String}",
11
                         "stock": {
12
                              "stockQuantity
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}",
13
                              "availableStockQuantity
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}"
14
                         },
15
                         "productLink
ProductLink

Product reference

": "{String}"
16
                    },
17
                    "accessoryLink
AccessoryLink

Accessory reference

": "{String}"
18
               },
19
               "productLocation
ProductLocation

When specifying object type and object id, we also have a product location we can show availbable stock quantity from

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

": {
20
                    "location
Location

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

": {
21
                         "shortName
ShortName

Unique abbreviation/short name of the location

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

": "{String}"
22
                    },
23
                    "stock
Stock

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

": {
24
                         "stockQuantity
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.

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

": "{Decimal}",
25
                         "availableStockQuantity
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.

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

": "{Decimal}"
26
                    }
27
               },
28
               "lowestPrice
LowestPrice

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

": {
29
                    "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
30
                    "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

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

": "{Decimal}",
31
                    "discount
Discount

Discount price

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

": "{Decimal}",
32
                    "netPrice
NetPrice

Final price per unit after deducting all discounts etc.

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

": "{Decimal}",
33
                    "basedOn
BasedOn

Specifies what the lowest price was based on. Could be QUOTE, STANDARD or IPA.

Possible domain values can be found here

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

": "{String}",
34
                    "salesQuoteItem
SalesQuoteItem

If the price is based on a sales quote, a reference to the related quote will be provided.

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

": {
35
                         "salesQuoteItemId
SalesQuoteItemId

Sales quote item identifier

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

": "{Integer}",
36
                         "salesQuote
SalesQuote

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

": {
37
                              "salesQuoteId
SalesQuoteId

Sales quote identifier

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

": "{Integer}",
38
                              "salesQuoteLink
SalesQuoteLink

Sales quote reference

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

": "{String}"
39
                         },
40
                         "salesQuoteItemLink
SalesQuoteItemLink

Sales quote item referene

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

": "{String}"
41
                    }
42
               },
43
               "prices
Prices

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

": [
44
                    {
45
                         "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
46
                         "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

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

": "{Decimal}",
47
                         "discount
Discount

Discount price

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

": "{Decimal}",
48
                         "netPrice
NetPrice

Final price per unit after deducting all discounts etc.

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

": "{Decimal}",
49
                         "basedOn
BasedOn

Specifies what the lowest price was based on. Could be QUOTE, STANDARD or IPA.

Possible domain values can be found here

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

": "{String}",
50
                         "salesQuoteItem
SalesQuoteItem

If the price is based on a sales quote, a reference to the related quote will be provided.

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

": {
51
                              "salesQuoteItemId
SalesQuoteItemId

Sales quote item identifier

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

": "{Integer}",
52
                              "remainingQuantity
RemainingQuantity

Remaining number of units to be forwarded.

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

": "{Decimal}",
53
                              "salesQuote
SalesQuote

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

": {
54
                                   "salesQuoteId
SalesQuoteId

Sales quote identifier

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

": "{Integer}",
55
                                   "salesQuoteLink
SalesQuoteLink

Sales quote reference

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

": "{String}"
56
                              },
57
                              "salesQuoteItemLink
SalesQuoteItemLink

Sales quote item referene

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

": "{String}"
58
                         }
59
                    }
60
               ]
61
          }
62
     ],
63
     "paging
Paging

Detailed paging information for this list.

": {
64
          "pageSize
PageSize

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

": "{Integer}",
65
          "position
Position

Position of the first element in the list

": "{Integer}",
66
          "page
Page

Page index

": "{Integer}",
67
          "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}",
68
          "firstPage
FirstPage

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

": "{String}",
69
          "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}",
70
          "previousPage
PreviousPage

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

": "{String}",
71
          "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}",
72
          "nextPage
NextPage

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

": "{String}",
73
          "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}",
74
          "lastPage
LastPage

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

": "{String}",
75
          "size
Size

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

": "{Integer}"
76
     }
77
}

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}