Orders / Statuses
List Order Statuses
Returns all Orders Statuses available.
You will only receive the Orders Statuses 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 |
| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |
RESPONSE
This endpoint returns all Order Statuses available for the value list.
List of the supported Orders Statuses attributes:
| Attribute | Type | Description |
|---|---|---|
| branchVisibility | Object, Null | In which Branch the Order Status is visible |
| dateCreated | String | Date and time when the Order Status was created |
| dateDeleted | String | Date and time when the Order Status was deleted |
| dateUpdated | String | Date and time when the Order Status was last updated |
| deleted | Boolean | If true, the Order Status has been deleted and archived |
| 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 |
| id | Integer | Unique identifier for the Order Status in ForceManager |
| won | Boolean | If true, the Order has been won |
| lost | Boolean | If true, the Order has been lost |
| order | Integer | The position of the Order Status in the Order Statuses value list |
| salesRepIdCreated | Integer | Unique identifier of the user who created the Order Status |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Order Status |
| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Order 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 |
get/salesorderStatuses
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/salesorderStatuses
- Auth: API key in header X-Session-Key
Headers
Acceptstring
X-FM-Entity-Countstring
Response
List Order Statuses
Changes
No recorded changes to this operation across all 1 revision of this API.