Sales APIs
List of all sales order request items
HTTP method | GET |
URI | https://api.rambase.net/sales/order-request-items |
Supported formats | Xml, Html, Json (ex. $format=json) |
Maximum page size ($top) | 80 |
Custom fields | Custom fields supported |
Successful HTTP status code | 200 |
API resource identifier | 2108, version 26 |
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 |
$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" |
$showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
$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.
InfoNotification() Named filter | Sales order request items with notification of category I (Information) |
MyItems() Named filter | Items which belong to a sales order request the current user is either assigned to, sales assistent for or account manager for. |
PendingForward() Named filter | Sales order request items pending forward to sales order |
AccountManager Integer | Reference to the employee who is responsible for the management of sales, and relationship with the customer. Available macros: currentUser() |
Assignee Integer | The user who has been assigned to work with this object. Available macros: currentUser() |
ContainingNotificationTypeId Integer | Notification type identifier. |
ConvertedExpectedAmount Decimal | Total net amount in company currency. |
ConvertedExpectedPrice Decimal | Expected price in company currency. |
ConvertedRemainingAmount Decimal | Total remaining amount in company currency. |
CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
CustomerFirstname String | Secondary name of a company or firstname of a person. |
CustomerId Integer | Customer identifier. |
CustomerName String | Name of customer (name of company or surname/familyname/lastname of a person). |
EndCustomerFirstName String | Secondary name of a company or firstname of a person. |
EndCustomerId Integer | Customer identifier. |
EndCustomerName String | Name of customer (name of company or surname/familyname/lastname of a person). |
ExpectedAmount Decimal | Represents the expected item amount. |
ExpectedPrice Decimal | The expected price received from the customer. This price will be rejected or accepted by the seller. |
FromSubscriptionId Integer | Subscription this order request was created from. |
ManufacturerId Integer | Manufacturer identifier. |
ProductDescription String | Description of the item. If not specified, the description is by default copied from the product. |
ProductId Integer | Product identifier. |
ProductName String | Name of the product. |
Quantity Decimal | The quantity requested. |
RemainingAmount Decimal | Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice. |
RemainingQuantity Decimal | Remaining number of units to be forwarded. |
RequestedDeliveryDate Date | The delivery date as requested by the customer. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
SalesAssistant Integer | Reference to the employee who is sales assistant for the customer. Available macros: currentUser() |
SalesOrderRequestId Integer | Sales order request identifier. |
SalesOrderRequestItemId Integer | Sales order request item identifier. |
Status Integer | Status of the sales order request identifier. |
Read more about filters and sorting on how to use sortable parameters
AccountManager Integer | Reference to the employee who is responsible for the management of sales, and relationship with the customer. |
Assignee Integer | The user who has been assigned to work with this object. |
ContainingNotificationTypeId Integer | Notification type identifier |
ConvertedExpectedAmount Decimal | Total net amount in company currency. |
ConvertedExpectedPrice Decimal | Expected price in company currency |
ConvertedRemainingAmount Decimal | Total remaining amount in company currency. |
CreatedAt Datetime | Date and time of creation |
CustomerFirstname String | Secondary name of a company or firstname of a person |
CustomerId Integer | Customer identifier |
CustomerName String | Name of customer (name of company or surname/familyname/lastname of a person) |
EndCustomerFirstName String | Secondary name of a company or firstname of a person |
EndCustomerId Integer | Customer identifier |
EndCustomerName String | Name of customer (name of company or surname/familyname/lastname of a person) |
ExpectedAmount Decimal | Represents the expected item amount |
ExpectedPrice Decimal | The expected price received from the customer. This price will be rejected or accepted by the seller |
FromSubscriptionId Integer | Subscription this order request was created from |
ManufacturerId Integer | Manufacturer identifier |
ProductDescription String | Description of the item. If not specified, the description is by default copied from the product. |
ProductId Integer | Product identifier |
ProductName String | Name of the product |
Quantity Decimal | The quantity requested |
RemainingAmount Decimal | Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice |
RemainingQuantity Decimal | Remaining number of units to be forwarded. |
RequestedDeliveryDate Date | The delivery date as requested by the customer. |
SalesAssistant Integer | Reference to the employee who is sales assistant for the customer. |
SalesOrderRequestId Integer | Sales order request identifier |
SalesOrderRequestItemId Integer | Sales order request item identifier |
Status Integer | Status of the sales order request identifier |
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.
SalesOrderRequestItemId
Sales order request item identifier
>{Integer}</SalesOrderRequestItemId>Status
Status of the sales order request identifier
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>RequestedDeliveryDate
The delivery date as requested by the customer.
>{Date}</RequestedDeliveryDate>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
>{String}</ProductDescription>GrossMargin
Gross margin of the item.
>{Decimal}</GrossMargin>CustomersReferenceNumber
Customers item reference number. Typically to the customers internal system.
>{String}</CustomersReferenceNumber>CustomersProductName
Customers internal name of the product. Retrieved from the product.
>{String}</CustomersProductName>RequestedProductStructureRevision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
>{String}</RequestedProductStructureRevision>Quantity
The quantity requested
>{Decimal}</Quantity>RemainingQuantity
Remaining number of units to be forwarded.
>{Decimal}</RemainingQuantity>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>ExpectedPrice
The expected price received from the customer. This price will be rejected or accepted by the seller
>{Decimal}</ExpectedPrice>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>ExpectedAmount
Represents the expected item amount
>{Decimal}</ExpectedAmount>RemainingAmount
Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice
>{Decimal}</RemainingAmount>MeasurementUnitId
Measurement unit identifier
>{Integer}</MeasurementUnitId>Unit
Measurement unit (ex. mm, km, dl, kg)
>{String}</Unit>MeasurementUnitLink
Material unit reference
>{String}</MeasurementUnitLink>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ManufacturerId
Manufacturer identifier
>{Integer}</ManufacturerId>ManufacturerLink
Manufacturer reference
>{String}</ManufacturerLink>ProductLink
Product reference
>{String}</ProductLink>GrossPrice
Total cost (landed cost or true cost) of getting each unit in stock, including purchase price, duties, charges, freight etc.
>{Decimal}</GrossPrice>PurchaseExchangeRate
Exchange rate between document currency and purchase currency. Used in landed cost calculations.
>{Decimal}</PurchaseExchangeRate>SalesOrderRequestId
Sales order request identifier
>{Integer}</SalesOrderRequestId>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>Firstname
Secondary name of a company or firstname of a person
>{String}</Firstname>CustomerLink
Customer reference
>{String}</CustomerLink>SalesOrderRequestLink
Sales order request reference
>{String}</SalesOrderRequestLink>SalesOrderRequestItemLink
Sales order request reference
>{String}</SalesOrderRequestItemLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>SalesOrderRequestItemId
Sales order request item identifier
": "{Integer}",Status
Status of the sales order request identifier
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",RequestedDeliveryDate
The delivery date as requested by the customer.
": "{Date}",ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
": "{String}",GrossMargin
Gross margin of the item.
": "{Decimal}",CustomersReferenceNumber
Customers item reference number. Typically to the customers internal system.
": "{String}",CustomersProductName
Customers internal name of the product. Retrieved from the product.
": "{String}",RequestedProductStructureRevision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
": "{String}",Quantity
The quantity requested
": "{Decimal}",RemainingQuantity
Remaining number of units to be forwarded.
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",ExpectedPrice
The expected price received from the customer. This price will be rejected or accepted by the seller
": "{Decimal}"Currency
Three character code following the ISO 4217 standard
": "{String}",ExpectedAmount
Represents the expected item amount
": "{Decimal}",RemainingAmount
Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice
": "{Decimal}"MeasurementUnitId
Measurement unit identifier
": "{Integer}",Unit
Measurement unit (ex. mm, km, dl, kg)
": "{String}",MeasurementUnitLink
Material unit reference
": "{String}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",ManufacturerId
Manufacturer identifier
": "{Integer}",ManufacturerLink
Manufacturer reference
": "{String}"ProductLink
Product reference
": "{String}"GrossPrice
Total cost (landed cost or true cost) of getting each unit in stock, including purchase price, duties, charges, freight etc.
": "{Decimal}",PurchaseExchangeRate
Exchange rate between document currency and purchase currency. Used in landed cost calculations.
": "{Decimal}"SalesOrderRequestId
Sales order request identifier
": "{Integer}",CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",Firstname
Secondary name of a company or firstname of a person
": "{String}",CustomerLink
Customer reference
": "{String}"SalesOrderRequestLink
Sales order request reference
": "{String}"SalesOrderRequestItemLink
Sales order request reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",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 100147 HTTP 404 | Notification type not found |