Products / Entity
Get Product
This endpoint retrieves data of a specific Product based on JSON input. The API returns a single Product available to the user, according to the unique Product ID provided. If the specified Product does not exist, the response will be a "bad request".
You will only receive the Product 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 |
| 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
| Parameter | Type | Description |
|---|---|---|
| id | Integer | The unique and specific identifier for the Product |
RESPONSE
| 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 |
get/products/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/products/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
ExtraFieldDescriptionstring
X-FM-Entity-Countstring
Response
Get Product
Changes
No recorded changes to this operation across all 1 revision of this API.