Products / Entity
Bulk Create Products
This endpoint allows you to create Multiple Products (100 entities for request) based on JSON input.
You will only be able to create Multiple 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 |
REQUEST
You have to send a Array with the following JSON data:
| Parameter | Type | Description |
|---|---|---|
| guid | String | Unique operation identifier |
| data | Object | JSONObject with the Product data (same data as Create Product method) |
You can check the "data" object in the following table:
| Parameter | Type | Description |
|---|---|---|
| categoryId | Object, Null | Id of the Category that the Product belongs to (see Categories resource) |
| cost | Number | Cost of the Product |
| description | String | Description of the Product |
| extId | String | External ID of the Product from a third party system (ERP, CRM, Accounting System) |
| familyId | Integer | Id of the Family that the Product belongs to (see Families resource) |
| maxDiscount | Number | Maximum discount that can be applied to the Product in percents |
| model (Required) | 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 |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| guid | Integer | Unique operation identifier |
| id | Integer | Id assigned to the new Account |
| Message | String | 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 |
post/products/bulk
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/products/bulk
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Request body
object[] required
Response
Bulk Create Products
Changes
No recorded changes to this operation across all 1 revision of this API.