List Products
Returns all Products available in the user's ForceManager implementation database.
You will only receive the Products 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 |
| X-FM-Entity-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/products?page=PAGE_NUMBER
You can apply filters.
e.g.
https://api.forcemanager.com/api/v4/products?where= param1=value AND/OR param2=value2
You can filter Products by dateCreated, familyId and model for example.
You can also organise and view the results for Rates 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/products?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/products?lang=VALUE
RESPONSE
This endpoint returns information about all Products 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 Products attributes:
| Attribute | Type | Description |
|---|---|---|
| categoryId | Object, Null | Id of the Category that the Product belongs to (see Categories resource) |
| cost | Number | Cost of the Product |
| dateCreated | String | Date and time when the Product was created |
| dateDeleted | String | Date and time when the Product was deleted |
| dateUpdated | string | Date and time when the Product was last updated |
| deleted | Boolean | If true, the Product has been deleted and archived |
| description | String | Description of the Product |
| extId | String | External ID of the Product from a third party system (ERP, CRM, Accounting System) |
| familyId | Object, Null | Id of the Family that the Product belongs to (see Families resource) |
| id | Integer | Unique identifier for the Product in ForceManager |
| maxDiscount | Number | Maximum discount that can be applied to the Product in percents |
| model | String | Product name |
| notAvailable | Boolean | If true, the Product is not available |
| permissionLevel | Integer | Defines the visibility of the Product. Set from 1 to 5 being 5 the highest level of permission |
| price | Number | Specific price for the Product |
| stock | Integer | Amount of Product in stock |
| readOnly | Boolean | If true, the Product can not be modified or deleted |
| salesRepIdCreated | Integer | Unique identifier of the User who created the Product |
| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Product |
| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Product |
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/products
- Auth: API key in header X-Session-Key
Headers
Response
List Products
Changes
No recorded changes to this operation across all 1 revision of this API.