Orders / Entity
Update Order Line
This endpoint allows you to update a specific Order Line. If the specified Line does not exist, the response will be a "bad request".
You will only be able to update a Order Line after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
HEADERS
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
REQUEST
This endpoint allows updating the information of a specific Order Line. In order to update a Line, you just have to specify the attributes you want to modify and complete with the up to date information. It is not necessary to send all attributes.
| Attribute | Type | Description |
|---|---|---|
| quantity | Integer | Quantity of Product for the Order Line |
| price | Number | Price of the Order Line |
| description | String | Description added to the Order Line |
| discount1 | Number | First discount that can be applied to the Order Line in percents |
| discount2 | Number | Second discount that can be applied to the Order Line in percents |
| discount3 | Number | Third discount that can be applied to the Order Line in percents |
| discount4 | Number | Forth discount that can be applied to the Order Line in percents |
| total | Number | Total amount of the Order Line |
| productId | Integer | Id of the Product related to the Order Line (see Products resource) |
| salesOrderId | Integer | Id of the Order Header (see Headers resource) |
| order | Integer | The position of the Order Line in the whole Lines list |
RESPONSE
Returns a JSON with information about the Order Line just updated.
| Attribute | Description |
|---|---|
| Message | Shows the operation status |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
put/salesordersLines/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/salesordersLines/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Request body
Response
Update Order Line
Changes
No recorded changes to this operation across all 1 revision of this API.