Get all statuses

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/statuses

Get information as a collection of all recent statuses.

Responses

Response body

object

data

object

statuses

array of objects

List of recent statuses.

statuses

object

status_id

string

The unique ID of the status.

name

string

required

Name of the status.

description

string

required

Short description of the status.

qualification_period

integer

The period of time (in months) in which it is necessary to qualify for the status based on defined conditions.

qualification_turnover

array of objects

The turnover necessary to qualify for the status based on defined conditions.

qualification_turnover

object

currency_id

string

required

The unique ID of the currency.

value

float

required

Value of turnover in the currency

due_date

string

Date until the turnover conditions need to be fulfilled. If the value is null, the date is unlimited.

qualification_points

float

Amount of points necessary to qualify for the status based on defined conditions.

previous_status

string

The previous status required to qualify for the next status based on defined conditions. The conditions are defined in parameters qualification_period and qualification_turnover.

next_status

string

ID of the following status.

validity_period

string

required

Definition of the status validity period.

collection_points

boolean

required

Enable / disable points collection.

true

payment_points

boolean

required

Enable / disable payment by points.

true

qualification_type

integer

required

The status achieving principle.
(0 - after creation of the account / 1 - manually / 2 - after the defined conditions are met)

discount

integer

required

The basic loyalty discount.

overall_discount_on_discounted_purchase_items

boolean

If true, overall discounts can be applied on already discounted purchase items in purchase checkout process.

true

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

total_items

integer

The number of all found statuses.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/statuses?count=100&offset=0' \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
30
}
1
{
2
  "data": {
3
    "statuses": [
4
      {
5
        "status_id": "86e05affc7a7abefcd513ab400",
6
        "name": "Basic",
7
        "description": null,
8
        "qualification_period": 12,
9
        "qualification_turnover": [
10
          {
11
            "currency_id": "86e05affc7a7abefcd513ab400",
12
            "value": 1500,
13
            "due_date": "string"
14
          }
15
        ],
16
        "qualification_points": 3000,
17
        "previous_status": null,
18
        "next_status": "83d1d11ea3884a5d33253fe214",
19
        "validity_period": "2 years",
20
        "collection_points": true,
21
        "payment_points": true,
22
        "qualification_type": 1,
23
        "discount": 0,
24
        "overall_discount_on_discounted_purchase_items": true,
25
        "last_change": "2019-01-04 10:31:56"

200OK

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.