API

Sales APIs

GET sales/order-change-requests/{salesOrderChangeRequestId}/items/{itemId}

Details of provided sales order change request item

HTTP method GET
URI https://api.rambase.net/sales/order-change-requests/{salesOrderChangeRequestId}/items/{itemId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {salesOrderChangeRequestId} Sales order change request identifier
Integer, minimum 100000
- URI parameter {itemId} Sales order change request item identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 2628, version 1

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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$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.

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

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

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<SalesOrderChangeRequestItem>
2
     <SalesOrderChangeRequestItemId
SalesOrderChangeRequestItemId

Sales order change request item identifier

>{Integer}</SalesOrderChangeRequestItemId>
3
     <Status
Status

Status of sales order change request

Possible domain values can be found here

>{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
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
     <RequestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

>{Date}</RequestedDeliveryDate>
7
     <CustomersProductName
CustomersProductName

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

>{String}</CustomersProductName>
8
     <EquivalentProductName
EquivalentProductName

Name of product with equivalent behavior and attributes. Can be used for same purpose.

>{String}</EquivalentProductName>
9
     <RequestedProductStructureRevision
RequestedProductStructureRevision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

>{String}</RequestedProductStructureRevision>
10
     <ProductDescription
ProductDescription

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

>{String}</ProductDescription>
11
     <DiscountPercent
DiscountPercent

The discount in percent for this item.

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

Requested quantity. Might be negative if cancelled

>{Decimal}</Quantity>
13
     <Price>
14
          <Currency
Currency

Three character code following the ISO 4217 standard

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

Represents the price per unit before any discounting is applied.

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

The discount for the item.

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

Final price per unit after deducting all discounts etc.

>{Decimal}</NetPrice>
18
     </Price>
19
     <MeasurementUnit>
20
          <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

>{Integer}</MeasurementUnitId>
21
          <Unit
Unit

Measurement unit (ex. mm, km, dl, kg)

>{String}</Unit>
22
          <MeasurementUnitLink
MeasurementUnitLink

Material unit reference

>{String}</MeasurementUnitLink>
23
     </MeasurementUnit>
24
     <Product>
25
          <ProductId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

>{String}</Type>
28
          <Manufacturer>
29
               <ManufacturerId
ManufacturerId

Manufacturer identifier

>{Integer}</ManufacturerId>
30
               <Name
Name

Company name of the manufacturer.

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

>{String}</Name>
31
               <ShortName
ShortName

Shortname/code of the manufacturer

>{String}</ShortName>
32
               <ManufacturerLink
ManufacturerLink

Manufacturer reference

>{String}</ManufacturerLink>
33
          </Manufacturer>
34
          <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
35
     </Product>
36
     <InitialSalesOrderItem
InitialSalesOrderItem

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

>
37
          <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

>{Integer}</SalesOrderItemId>
38
          <SalesOrder>
39
               <SalesOrderId
SalesOrderId

Sales order identifier

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

Sales order reference

>{String}</SalesOrderLink>
41
          </SalesOrder>
42
          <SalesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

>{String}</SalesOrderItemLink>
43
     </InitialSalesOrderItem>
44
     <ForwardedToSalesOrderItem
ForwardedToSalesOrderItem

Item this item was forwarded to.

>
45
          <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

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

Sales order identifier

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

Sales order reference

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

Reference to the sales order item.

>{String}</SalesOrderItemLink>
51
     </ForwardedToSalesOrderItem>
52
</SalesOrderChangeRequestItem>
1
{
2
     "salesOrderChangeRequestItem": {
3
          "salesOrderChangeRequestItemId
SalesOrderChangeRequestItemId

Sales order change request item identifier

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

Status of sales order change request

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

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

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

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

The delivery date as requested by the customer.

": "{Date}",
8
          "customersProductName
CustomersProductName

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

": "{String}",
9
          "equivalentProductName
EquivalentProductName

Name of product with equivalent behavior and attributes. Can be used for same purpose.

": "{String}",
10
          "requestedProductStructureRevision
RequestedProductStructureRevision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

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

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

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

The discount in percent for this item.

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

Requested quantity. Might be negative if cancelled

": "{Decimal}",
14
          "price": {
15
               "currency
Currency

Three character code following the ISO 4217 standard

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

Represents the price per unit before any discounting is applied.

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

The discount for the item.

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

Final price per unit after deducting all discounts etc.

": "{Decimal}"
19
          },
20
          "measurementUnit": {
21
               "measurementUnitId
MeasurementUnitId

Measurement unit identifier

": "{Integer}",
22
               "unit
Unit

Measurement unit (ex. mm, km, dl, kg)

": "{String}",
23
               "measurementUnitLink
MeasurementUnitLink

Material unit reference

": "{String}"
24
          },
25
          "product": {
26
               "productId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

": "{String}",
29
               "manufacturer": {
30
                    "manufacturerId
ManufacturerId

Manufacturer identifier

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

Company name of the manufacturer.

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

": "{String}",
32
                    "shortName
ShortName

Shortname/code of the manufacturer

": "{String}",
33
                    "manufacturerLink
ManufacturerLink

Manufacturer reference

": "{String}"
34
               },
35
               "productLink
ProductLink

Product reference

": "{String}"
36
          },
37
          "initialSalesOrderItem
InitialSalesOrderItem

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

": {
38
               "salesOrderItemId
SalesOrderItemId

Sales order item identifier

": "{Integer}",
39
               "salesOrder": {
40
                    "salesOrderId
SalesOrderId

Sales order identifier

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

Sales order reference

": "{String}"
42
               },
43
               "salesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

": "{String}"
44
          },
45
          "forwardedToSalesOrderItem
ForwardedToSalesOrderItem

Item this item was forwarded to.

": {
46
               "salesOrderItemId
SalesOrderItemId

Sales order item identifier

": "{Integer}",
47
               "salesOrder": {
48
                    "salesOrderId
SalesOrderId

Sales order identifier

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

Sales order reference

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

Reference to the sales order item.

": "{String}"
52
          }
53
     }
54
}

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 101814 HTTP 404 Employee not found
Error 100055 HTTP 403 You have only admittance to your own objects