Orders / Entity
Get Order Line
This endpoint retrieves data of a specific Order Line based on JSON input. The API returns a single Line available to the user, according to the unique ID provided. If the specified Order Line does not exist, the response will be a "bad request".
You will only receive the 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
| Parameter | Type | Description |
|---|---|---|
| id | Integer | The unique and specific identifier of the Order Line |
RESPONSE
| 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 | Object, Null | Id of the Product related to the Order Line (see Products resource) |
| salesOrderId | Object, Null | Id of the Order Header (see Headers resource) |
| order | Integer | The position of the Order Line in the whole Lines list |
| dateCreated | String | Date and time when the Order Line was created |
| dateDeleted | String | Date and time when the Order Line was deleted |
| dateUpdated | String | Date and time when the Order Line was last updated |
| deleted | Boolean | If true, the Order Line has been deleted and archived |
| id | Integer | Unique identifier for the Order Line in ForceManager |
| salesRepIdCreated | Integer | Unique identifier of the user who created the Order Line |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Order Line |
| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Order Line |
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 |
get/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
X-FM-Entity-Countstring
Response
Get Order Line
Changes
No recorded changes to this operation across all 1 revision of this API.