Variables

Variable list

GET https://app.hightouch.ai/api/store/custom_fields/

Query Parameters

Name	Type	Description
shop_id	integer	ID магазина
limit	integer	Кол-во записей (макс. 100)
offset	integer	Сдвиг по записям
search	string	Строка поиска по названию или ID переменной

200

{
  "status": "ok",
  "result": {
    "count": 42,
    "next": null,
    "previous": null,
    "results": [
      {
        "id": 577,
        "shop_id": 2,
        "name": "about",
        "dtype": {
          "id": "text",
          "name": "Текст"
        },
        "description": null
      },
      ...
    ]
  }
}

401

{
    "status": "error",
    "errors": {
        "detail": "Недопустимый токен."
    }
}

Add new variable

POST https://app.hightouch.ai/api/store/custom_fields/

Variables include the following types: text - the line; number - integer or fractional number; bool - Boolean type ("Yes/No"); image - saves the URL of the picture; json - saves a JSON object of any structure;

Request Body

Name	Type	Description
shop_id	integer	ID магазина
name	string	Название переменной (латиницей)
dtype	object	Тип данных. Например, {"id": "number"}
description	string	Описание переменной

200

{
  "status": "ok",
  "result": {
    "id": 758,
    "shop_id": 2,
    "name": "my_new_var",
    "dtype": {
      "id": "number",
      "name": "Число"
    },
    "description": "Новая переменная"
  }
}

401

{
    "status": "error",
    "errors": {
        "detail": "Недопустимый токен."
    }
}

Change a variable

PATCH https://app.hightouch.ai/api/store/custom_fields/:id/

Path Parameters

Name	Type	Description
id	integer	Variable ID

Request Body

Name	Type	Description
shop_id	integer	Store ID
name	string	New name of the variable
description	string	New description of the variable

200

 {
  "status": "ok",
  "result": {
    "id": 758,
    "shop_id": 2,
    "name": "my_new_var",
    "dtype": {
      "id": "number",
      "name": "Число"
    },
    "description": "Новая переменная"
  }
}

401

{
    "status": "error",
    "errors": {
        "detail": "Недопустимый токен."
    }
}

Delete a variable

DELETE https://app.hightouch.ai/api/store/custom_fields/:id/

Path Parameters

Name	Type	Description
id	integer	Variable ID

200

401

{
    "status": "error",
    "errors": {
        "detail": "Недопустимый токен."
    }
}