List Order Lines
Returns all Orders Lines available in the user's ForceManager implementation database.
You will only receive the List of Orders Lines 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 |
| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |
| ExtraFieldDescription | {number} | If equal to "0", the response returns only the value of each Extra Fields, if equal to "1" also the description is returned |
REQUEST
You can apply filters, organise and choose the language and pagination using any query string parameter in SQL. Query string parameters appear after a question mark in the endpoint followed by the parameters and their values. In the query string, each parameter is listed one right after the other with an AND separating them. The order of the parameters does not matter.
| Parameter | Type | Description |
|---|---|---|
| page | Integer | Define the pagination data for the returned objects |
| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |
| order | String | organise and view the results for a specific attribute in descendent order - at the top the most recent results while the oldest results will be down the list |
| lang | String | Define the language in which you want to receive the response |
You can define the pagination data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.
e.g.
https://api.forcemanager.com/api/v4/salesordersLines?page=PAGE_NUMBER
You can apply filters.
e.g.
https://api.forcemanager.com/api/v4/salesordersLines?where= param1=value AND/OR param2=value2
You can filter Order Lines by dateCreated or total for example.
You can also organise and view the results for Order Lines in descendent order - at the top, the most recent results while the oldest results will be down the list.
e.g.
https://api.forcemanager.com/api/v4/salesordersLines?order=VALUE
In the request, and using query string parameters, you can also define the language in which you want to receive the response.
e.g.
https://api.forcemanager.com/api/v4/salesordersLines?lang=VALUE
RESPONSE
This endpoint returns information about all Order Lines available in the database.
If you didn't apply any page or count number in the header the default number of records in the response is 50.
List of the supported Order Lines 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 | 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 |
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/salesordersLines
- Auth: API key in header X-Session-Key
Headers
Response
List Order Lines filtered by Order Id
Changes
No recorded changes to this operation across all 1 revision of this API.