Sales APIs
Sales order change request details for provided identifier
| HTTP method | GET |
| URI | https://api.rambase.net/sales/order-change-requests/{salesOrderChangeRequestId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {salesOrderChangeRequestId} |
Sales order change request identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 613, version 16 |
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 |
| $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.
SalesOrderChangeRequestId
Sales order change request identifier
>{Integer}</SalesOrderChangeRequestId>Status
Status of sales order change request
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>RegistrationDate
Date of registration
>{Date}</RegistrationDate>CustomersReference
Customers reference. Typically a person.
>{String}</CustomersReference>CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
>{String}</CustomersReferenceNumber>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
>{String}</Note>InitialQuantity
The remaining quantity of the changed sales order item when this sales order change request was created.
>{Decimal}</InitialQuantity>CancelledQuantity
The total cancelled quantity in this sales order change request. Cannot be higher than the initial quantity.
>{Decimal}</CancelledQuantity>ChangeReason
States the reason why the sales order change request item was created
Possible domain values can be found here
>{String}</ChangeReason>ChangedSalesOrderItem
The sales order item beeing requested for change
>SalesOrderItemId
Sales order item identifier
>{Integer}</SalesOrderItemId>Status
Status of the sales order item (0-9).
Possible domain values can be found here
>{Integer}</Status>RequestedDeliveryDate
The delivery date as requested by the customer.
>{Date}</RequestedDeliveryDate>ConfirmedDeliveryDate
Confirmed date of delivery. Date of which the customer can expect the arriving goods
>{Date}</ConfirmedDeliveryDate>CustomersReferenceNumber
Customers item reference number. Typically to the customers internal system.
>{String}</CustomersReferenceNumber>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
Number of units ordered
>{Decimal}</Quantity>MeasurementUnitId
Measurement unit identifier
>{Integer}</MeasurementUnitId>Unit
Measurement unit (ex. mm, km, dl, kg)
>{String}</Unit>MeasurementUnitLink
Material unit reference
>{String}</MeasurementUnitLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>GrossPrice
Represents the price per unit before any discounting is applied.
>{Decimal}</GrossPrice>Discount
The discount for the item.
>{Decimal}</Discount>NetPrice
Final price per unit after deducting all discounts etc.
>{Decimal}</NetPrice>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>SalesOrderId
Sales order identifier
>{Integer}</SalesOrderId>CustomersReference
Customers reference. Typically a person.
>{String}</CustomersReference>CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
>{String}</CustomersReferenceNumber>SalesOrderLink
Sales order reference
>{String}</SalesOrderLink>SalesOrderItemLink
Reference to the sales order item.
>{String}</SalesOrderItemLink>SalesOrderId
Sales order identifier
>{Integer}</SalesOrderId>SalesOrderLink
Sales order reference
>{String}</SalesOrderLink>Assignee
The user who has been assigned to work with this object.
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>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>SalesOrderChangeRequestId
Sales order change request identifier
": "{Integer}",Status
Status of sales order change request
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",RegistrationDate
Date of registration
": "{Date}",CustomersReference
Customers reference. Typically a person.
": "{String}",CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
": "{String}",Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
": "{String}",InitialQuantity
The remaining quantity of the changed sales order item when this sales order change request was created.
": "{Decimal}",CancelledQuantity
The total cancelled quantity in this sales order change request. Cannot be higher than the initial quantity.
": "{Decimal}",ChangeReason
States the reason why the sales order change request item was created
Possible domain values can be found here
": "{String}",ChangedSalesOrderItem
The sales order item beeing requested for change
": {SalesOrderItemId
Sales order item identifier
": "{Integer}",Status
Status of the sales order item (0-9).
Possible domain values can be found here
": "{Integer}",RequestedDeliveryDate
The delivery date as requested by the customer.
": "{Date}",ConfirmedDeliveryDate
Confirmed date of delivery. Date of which the customer can expect the arriving goods
": "{Date}",CustomersReferenceNumber
Customers item reference number. Typically to the customers internal system.
": "{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
Number of units ordered
": "{Decimal}",MeasurementUnitId
Measurement unit identifier
": "{Integer}",Unit
Measurement unit (ex. mm, km, dl, kg)
": "{String}",MeasurementUnitLink
Material unit reference
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",GrossPrice
Represents the price per unit before any discounting is applied.
": "{Decimal}",Discount
The discount for the item.
": "{Decimal}",NetPrice
Final price per unit after deducting all discounts etc.
": "{Decimal}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",ProductLink
Product reference
": "{String}"SalesOrderId
Sales order identifier
": "{Integer}",CustomersReference
Customers reference. Typically a person.
": "{String}",CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
": "{String}",SalesOrderLink
Sales order reference
": "{String}"SalesOrderItemLink
Reference to the sales order item.
": "{String}"SalesOrderId
Sales order identifier
": "{Integer}",SalesOrderLink
Sales order reference
": "{String}"Assignee
The user who has been assigned to work with this object.
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"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}"
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 105969 HTTP 400 | Start date is required |
| Error 105970 HTTP 400 | End date is required |