API

RamBase REST APIs

GET sales/orders/{salesOrderId}/items

List of all order items for specified sales order

HTTP method GET
URI https://api.rambase.net/sales/orders/{salesOrderId}/items
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {salesOrderId} Sales order identifier
Integer, minimum 100000
Maximum page size ($top) 80
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 1811, version 38

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.

$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.

ConfirmedDeliveryDate Date Confirmed date of delivery. Date of which the customer can expect the arriving goods. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CustomersProductName String Customers internal name of the product. Retrieved from the product.
CustomersReferenceNumber String Customers item reference number. Typically to the customers internal system.
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).
GrossAmount Decimal Represents the item amount before any discounts etc. is applied.
GrossPrice Decimal Represents the price per unit before any discounting is applied.
IntercompanySalesOrderReferenceValue String Value for the field from the sales order in the other company.
LineNumber Integer Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
ManufacturerId Integer Manufacturer identifier.
NetAmount Decimal Final item amount after deducting all discounts etc.
PriceChangeAgreement Integer Defines if and how the recurring price can be updated.
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 Number of units ordered.
RecurringInvoicingStartDate Date Start date of subscription or rental item. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
RecurringPriceId Integer Recurring price indentifier.
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()
SalesOrderItemId Integer Sales order item identifier.
ScheduledShippingDate Date Date when the goods was/will be shipped from the warehouse. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Status Integer Status of the sales order item (0-9).
Type Integer Item type.

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

ConfirmedDeliveryDate Date Confirmed date of delivery. Date of which the customer can expect the arriving goods
CustomersProductName String Customers internal name of the product. Retrieved from the product.
CustomersReferenceNumber String Customers item reference number. Typically to the customers internal system.
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)
GrossAmount Decimal Represents the item amount before any discounts etc. is applied.
GrossPrice Decimal Represents the price per unit before any discounting is applied.
IntercompanySalesOrderReferenceValue String Value for the field from the sales order in the other company
LineNumber Integer Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
ManufacturerId Integer Manufacturer identifier
NetAmount Decimal Final item amount after deducting all discounts etc.
PriceChangeAgreement Integer Defines if and how the recurring price can be updated
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 Number of units ordered
RecurringInvoicingStartDate Date Start date of subscription or rental item
RecurringPriceId Integer Recurring price indentifier
RemainingQuantity Decimal Remaining number of units to be forwarded.
RequestedDeliveryDate Date The delivery date as requested by the customer.
SalesOrderItemId Integer Sales order item identifier
ScheduledShippingDate Date Date when the goods was/will be shipped from the warehouse.
Status Integer Status of the sales order item (0-9).
Type Integer Item type

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
<SalesOrderItems>
2
     <SalesOrderItem>
3
          <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

>{Integer}</SalesOrderItemId>
4
          <Type
Type

Item type

Possible domain values can be found here

>{Integer}</Type>
5
          <LineNumber
LineNumber

Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.

>{Integer}</LineNumber>
6
          <Status
Status

Status of the sales order item (0-9).

Possible domain values can be found here

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

The delivery date as requested by the customer.

>{Date}</RequestedDeliveryDate>
8
          <ConfirmedDeliveryDate
ConfirmedDeliveryDate

Confirmed date of delivery. Date of which the customer can expect the arriving goods

>{Date}</ConfirmedDeliveryDate>
9
          <IsConfirmedDeliveryDateLocked
IsConfirmedDeliveryDateLocked

If confirmed delivery date in sales order item (COA) is locked, this date should not be re-calculated automatically.

>{Boolean}</IsConfirmedDeliveryDateLocked>
10
          <CustomersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

>{String}</CustomersReferenceNumber>
11
          <CustomersProductName
CustomersProductName

Customers internal name of the product. Retrieved from the product.

>{String}</CustomersProductName>
12
          <ProductDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

>{String}</ProductDescription>
13
          <Note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

>{String}</Note>
14
          <DiscountPercent
DiscountPercent

The discount in percent for this item.

>{Decimal}</DiscountPercent>
15
          <Quantity
Quantity

Number of units ordered

>{Decimal}</Quantity>
16
          <RemainingQuantity
RemainingQuantity

Remaining number of units to be forwarded.

>{Decimal}</RemainingQuantity>
17
          <EndCustomer
EndCustomer

End customer

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

>
18
               <CustomerId
CustomerId

Customer identifier

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

>{Integer}</CustomerId>
19
               <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

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

>{String}</Name>
20
               <FirstName
FirstName

Secondary name of a company or firstname of a person

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

>{String}</FirstName>
21
               <VATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

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

>{String}</VATRegistrationNumber>
22
               <CustomerLink
CustomerLink

Customer reference

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

>{String}</CustomerLink>
23
          </EndCustomer>
24
          <Price>
25
               <Currency
Currency

Three character code following the ISO 4217 standard

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

Represents the price per unit before any discounting is applied.

>{Decimal}</GrossPrice>
27
               <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

>{Decimal}</NetPrice>
28
          </Price>
29
          <Totals>
30
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
31
               <GrossAmount
GrossAmount

Represents the item amount before any discounts etc. is applied.

>{Decimal}</GrossAmount>
32
               <NetAmount
NetAmount

Final item amount after deducting all discounts etc.

>{Decimal}</NetAmount>
33
          </Totals>
34
          <Product>
35
               <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
36
               <Name
Name

Name of the product

>{String}</Name>
37
               <Type
Type

Type of product

Possible domain values can be found here

>{String}</Type>
38
               <Manufacturer>
39
                    <ManufacturerId
ManufacturerId

Manufacturer identifier

>{Integer}</ManufacturerId>
40
                    <ManufacturerLink
ManufacturerLink

Manufacturer reference

>{String}</ManufacturerLink>
41
               </Manufacturer>
42
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
43
          </Product>
44
          <InitialSalesOrderItem
InitialSalesOrderItem

Reference to the initial/first/original sales order item in the document flow for this item.

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

>
45
               <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

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

>{Integer}</SalesOrderItemId>
46
               <SalesOrder
SalesOrder

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

>
47
                    <SalesOrderId
SalesOrderId

Sales order identifier

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

>{Integer}</SalesOrderId>
48
                    <SalesOrderLink
SalesOrderLink

Sales order reference

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

>{String}</SalesOrderLink>
49
               </SalesOrder>
50
               <SalesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

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

>{String}</SalesOrderItemLink>
51
          </InitialSalesOrderItem>
52
          <RecurringInvoicing>
53
               <PriceChangeAgreement
PriceChangeAgreement

Defines if and how the recurring price can be updated

Possible domain values can be found here

>{Integer}</PriceChangeAgreement>
54
               <StartDate
StartDate

Start date of subscription or rental item

>{Date}</StartDate>
55
               <ExpectedEndDate
ExpectedEndDate

Expected end date of subscription or rental item

>{Date}</ExpectedEndDate>
56
               <RecurringPrice>
57
                    <RecurringPriceId
RecurringPriceId

Recurring price indentifier

>{Integer}</RecurringPriceId>
58
                    <RecurringPriceLink
RecurringPriceLink

Recurring price reference

>{String}</RecurringPriceLink>
59
               </RecurringPrice>
60
          </RecurringInvoicing>
61
          <SalesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

>{String}</SalesOrderItemLink>
62
     </SalesOrderItem>
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}</PageSize>
65
          <Position
Position

Position of the first element in the list

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

Page index

>{Integer}</Page>
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}</FirstPageKey>
68
          <FirstPage
FirstPage

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

>{String}</FirstPage>
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}</PreviousPageKey>
70
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
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}</NextPageKey>
72
          <NextPage
NextPage

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

>{String}</NextPage>
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}</LastPageKey>
74
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
76
     </Paging>
77
</SalesOrderItems>
1
{
2
     "salesOrderItems": [
3
          {
4
               "salesOrderItemId
SalesOrderItemId

Sales order item identifier

": "{Integer}",
5
               "type
Type

Item type

Possible domain values can be found here

": "{Integer}",
6
               "lineNumber
LineNumber

Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.

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

Status of the sales order item (0-9).

Possible domain values can be found here

": "{Integer}",
8
               "requestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

": "{Date}",
9
               "confirmedDeliveryDate
ConfirmedDeliveryDate

Confirmed date of delivery. Date of which the customer can expect the arriving goods

": "{Date}",
10
               "isConfirmedDeliveryDateLocked
IsConfirmedDeliveryDateLocked

If confirmed delivery date in sales order item (COA) is locked, this date should not be re-calculated automatically.

": "{Boolean}",
11
               "customersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

": "{String}",
12
               "customersProductName
CustomersProductName

Customers internal name of the product. Retrieved from the product.

": "{String}",
13
               "productDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

": "{String}",
14
               "note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

": "{String}",
15
               "discountPercent
DiscountPercent

The discount in percent for this item.

": "{Decimal}",
16
               "quantity
Quantity

Number of units ordered

": "{Decimal}",
17
               "remainingQuantity
RemainingQuantity

Remaining number of units to be forwarded.

": "{Decimal}",
18
               "endCustomer
EndCustomer

End customer

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

": {
19
                    "customerId
CustomerId

Customer identifier

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

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

Name of customer (name of company or surname/familyname/lastname of a person)

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

": "{String}",
21
                    "firstName
FirstName

Secondary name of a company or firstname of a person

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

": "{String}",
22
                    "vATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

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

": "{String}",
23
                    "customerLink
CustomerLink

Customer reference

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

": "{String}"
24
               },
25
               "price": {
26
                    "currency
Currency

Three character code following the ISO 4217 standard

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

Represents the price per unit before any discounting is applied.

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

Final price per unit after deducting all discounts etc.

": "{Decimal}"
29
               },
30
               "totals": {
31
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
32
                    "grossAmount
GrossAmount

Represents the item amount before any discounts etc. is applied.

": "{Decimal}",
33
                    "netAmount
NetAmount

Final item amount after deducting all discounts etc.

": "{Decimal}"
34
               },
35
               "product": {
36
                    "productId
ProductId

Product identifier

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

Name of the product

": "{String}",
38
                    "type
Type

Type of product

Possible domain values can be found here

": "{String}",
39
                    "manufacturer": {
40
                         "manufacturerId
ManufacturerId

Manufacturer identifier

": "{Integer}",
41
                         "manufacturerLink
ManufacturerLink

Manufacturer reference

": "{String}"
42
                    },
43
                    "productLink
ProductLink

Product reference

": "{String}"
44
               },
45
               "initialSalesOrderItem
InitialSalesOrderItem

Reference to the initial/first/original sales order item in the document flow for this item.

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

": {
46
                    "salesOrderItemId
SalesOrderItemId

Sales order item identifier

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

": "{Integer}",
47
                    "salesOrder
SalesOrder

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

": {
48
                         "salesOrderId
SalesOrderId

Sales order identifier

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

": "{Integer}",
49
                         "salesOrderLink
SalesOrderLink

Sales order reference

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

": "{String}"
50
                    },
51
                    "salesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

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

": "{String}"
52
               },
53
               "recurringInvoicing": {
54
                    "priceChangeAgreement
PriceChangeAgreement

Defines if and how the recurring price can be updated

Possible domain values can be found here

": "{Integer}",
55
                    "startDate
StartDate

Start date of subscription or rental item

": "{Date}",
56
                    "expectedEndDate
ExpectedEndDate

Expected end date of subscription or rental item

": "{Date}",
57
                    "recurringPrice": {
58
                         "recurringPriceId
RecurringPriceId

Recurring price indentifier

": "{Integer}",
59
                         "recurringPriceLink
RecurringPriceLink

Recurring price reference

": "{String}"
60
                    }
61
               },
62
               "salesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

": "{String}"
63
          }
64
     ],
65
     "paging
Paging

Detailed paging information for this list.

": {
66
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
78
     }
79
}

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