Orders / Entity
Create Order Line
This endpoint allows you to create Orders Lines based on JSON input.
You will only be able to create 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 BODY
| Attribute | Type | Description |
|---|---|---|
| quantity (Required) | Integer | Quantity of Product for the Order Line |
| price (Required) | 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 (Required) | Integer | Id of the Product related to the Order Line (see Products resource) |
| salesOrderId | Integer | Id of the Order Header (see Headers resource) |
| order | Integer | The position of the Order Line in the whole Lines list |
RESPONSE
Returns a JSON with information about the Order Line just created.
| Attribute | Type | Description |
|---|---|---|
| id | Integer | Id assigned to the new Order Line |
| 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/salesOrdersLines
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
Acceptstring
Request body
Response
Create Order Line
Changes
No recorded changes to this operation across all 1 revision of this API.