API

Sales APIs

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

Stores information about sales order change item. Note that DiscountPercent will be ignored when Discount is provided.

HTTP method PUT
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 2634, 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
<SalesOrderChangeRequestItem
SalesOrderChangeRequestItem

This field is optional.

>
2
     <RequestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

The discount in percent for this item.

Minimum value: 0

Maximum value: 100

This field is optional.

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

Requested quantity. Might be negative if cancelled

Minimum value: 0

This field is optional.

>{Decimal}</Quantity>
9
     <Price
Price

This field is optional.

>
10
          <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

Minimum value: 0

This field is optional.

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

The discount for the item.

Minimum value: 0

This field is optional.

>{Decimal}</Discount>
12
     </Price>
13
     <Product
Product

This field is optional.

>
14
          <ProductId
ProductId

Product identifier

This field is optional.

>{Integer}</ProductId>
15
     </Product>
16
</SalesOrderChangeRequestItem>
1
{
2
     "salesOrderChangeRequestItem
SalesOrderChangeRequestItem

This field is optional.

": {
3
          "requestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

The discount in percent for this item.

Minimum value: 0

Maximum value: 100

This field is optional.

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

Requested quantity. Might be negative if cancelled

Minimum value: 0

This field is optional.

": "{Decimal}",
10
          "price
Price

This field is optional.

": {
11
               "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

Minimum value: 0

This field is optional.

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

The discount for the item.

Minimum value: 0

This field is optional.

": "{Decimal}"
13
          },
14
          "product
Product

This field is optional.

": {
15
               "productId
ProductId

Product identifier

This field is optional.

": "{Integer}"
16
          }
17
     }
18
}

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.

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

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
1

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 102447 HTTP 400 Missing both assignment id and item id parameters.
Error 103472 HTTP 400 Owner document has already cost set
Error 103838 HTTP 400 Recalculation failed. Missing location.
Error 103546 HTTP 400 Only product structures can be blocked for production
Error 107762 HTTP 400 Only product structures can auto create work orders for sub production
Error 107763 HTTP 400 Only product structures can be set up for line production
Error 107764 HTTP 400 Only product structures can be externally manufactured
Error 101047 HTTP 400 The purchase quote item has too low available quantity
Error 101400 HTTP 400 Supplier credit claim has been created from shipping advice
Error 102483 HTTP 400 Finance project is required for general ledger account {0}
Error 102484 HTTP 400 Asset is required for general ledger account {0}
Error 102485 HTTP 400 Dimension {0} ({1}) is required for general ledger account {2}
Error 101313 HTTP 400 Department number is not valid: {0}
Error 101320 HTTP 400 The project number is not valid: {0}
Error 101500 HTTP 400 Project {0} could not be used : Check project FromPeriod and ToPeriod.
Error 101501 HTTP 400 Asset is not allowed on general ledger account {0}
Error 101326 HTTP 400 The asset number is not valid : {0}
Error 102486 HTTP 400 Invalid value for dimension {0}