Orders / Statuses
Update Order Status
This endpoint allows you to update a specific Order Status. If the specified Status does not exist, the response will be a "bad request".
You will only be able to update an Order Status 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
This endpoint allows updating the information of a specific Order Status. In order to update a Status, you just have to specify the attributes you want to modify and complete with the up to date information. It is not necessary to send all attributes.
| Attribute | Type | Description |
|---|---|---|
| branchVisibility | Object, Null | In which Branch the Order Status is visible |
| descriptionBR | String | Order Status label in Brasilian Portuguese |
| descriptionDE | String | Order Status label in German |
| descriptionDK | String | Order Status label in Dutch |
| descriptionEN | String | Order Status label in English |
| descriptionES | String | Order Status label in Spanish |
| descriptionFR | String | Order Status label in French |
| descriptionIT | String | Order Status label in Italian |
| descriptionPT | String | Order Status label in Portuguese |
| descriptionRU | String | Order Status label in Russian |
| descriptionUS | String | Order Status label in American English |
| won | Boolean | If true, the Order has been won |
| lost | Boolean | If true, the Order has been lost |
| order | Integer | he position of the Order Status in the Order Statuses value list |
RESPONSE
Returns a JSON with information about the Order Status just updated.
| Attribute | Description |
|---|---|
| Message | 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 |
put/salesorderStatuses/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/salesorderStatuses/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Request body
Response
Update Order Status
Changes
No recorded changes to this operation across all 1 revision of this API.