Характеристики

Документация API для работы с характеристиками

Таблица с описанием полей:

Поле Тип Обязательное? Описание
id int Нет Уникальный идентификатор характеристики (обязательно при обновлении).
sp_key string Нет (сгененриуется автоматически) Уникальный ключ характеристики (например: "мощностьтыловыхколонок").
name_ro string Да Название характеристики на румынском языке.
name_ru string Да Название характеристики на русском языке.
name_en string Нет Название характеристики на английском языке (если требуется).
name_uk string Нет Название характеристики на украинском языке (если требуется).

1. Получение всех характеристик

Метод: GET
URL: {domain}/external/specification/

Описание:
Возвращает список всех характеристик сайта.

Пример запроса:

GET {domain}/external/specification/

Пример ответа:

[
    {
        "id": 97,
        "sp_key": "мощностьтыловыхколонок",
        "name_ro": "Puterea difuzoarelor din spate",
        "name_ru": "Мощность тыловых колонок",
        "name_en": null,
        "name_uk": null
    },
    {
        "id": 22,
        "sp_key": "времязарядки",
        "name_ro": "TIMP DE ÎNCĂRCARE",
        "name_ru": "ВРЕМЯ ЗАРЯДКИ",
        "name_en": null,
        "name_uk": null
    }
]

2. Получение одной характеристики

Метод: GET
URL: {domain}/external/specification/{id}/

Описание:
Возвращает данные одной характеристики.

Пример запроса:

GET {domain}/external/specification/97/

Пример ответа:

{
    "id": 97,
    "sp_key": "мощностьтыловыхколонок",
    "name_ro": "Puterea difuzoarelor din spate",
    "name_ru": "Мощность тыловых колонок",
    "name_en": null,
    "name_uk": null
}

3. Обновление одной характеристики

Метод: PUT
URL: {domain}/external/specification/{id}/

Описание:
Обновляет информацию об одной характеристике.

Пример запроса:

PUT {domain}/external/specification/97/
Content-Type: application/json

Тело запроса:

{
    "sp_key": "мощность_тыловых_колонок",
    "name_ro": "Puterea difuzoarelor spate",
    "name_ru": "Мощность тыловых колонок обновлено",
    "name_en": "Rear speaker power",
    "name_uk": "Потужність тилових колонок"
}

Пример ответа:

{
    "id": 97,
    "sp_key": "мощность_тыловых_колонок",
    "name_ro": "Puterea difuzoarelor spate",
    "name_ru": "Мощность тыловых колонок обновлено",
    "name_en": "Rear speaker power",
    "name_uk": "Потужність тилових колонок"
}

4. Создание нескольких характеристик

Метод: POST
URL: {domain}/external/specification/bulk-create/

Описание:
Создает несколько характеристик одновременно.

Пример запроса:

POST {domain}/external/specification/bulk-create/
Content-Type: application/json

Тело запроса:

[
    {
        "sp_key": "новая_характеристика_1",
        "name_ro": "Caracteristică nouă 1",
        "name_ru": "Новая характеристика 1",
        "name_en": "New specification 1",
        "name_uk": "Нова характеристика 1"
    },
    {
        "sp_key": "новая_характеристика_2",
        "name_ro": "Caracteristică nouă 2",
        "name_ru": "Новая характеристика 2",
        "name_en": "New specification 2",
        "name_uk": "Нова характеристика 2"
    }
]

Пример ответа:

[
    {
        "id": 101,
        "sp_key": "новая_характеристика_1",
        "name_ro": "Caracteristică nouă 1",
        "name_ru": "Новая характеристика 1",
        "name_en": "New specification 1",
        "name_uk": "Нова характеристика 1"
    },
    {
        "id": 102,
        "sp_key": "новая_характеристика_2",
        "name_ro": "Caracteristică nouă 2",
        "name_ru": "Новая характеристика 2",
        "name_en": "New specification 2",
        "name_uk": "Нова характеристика 2"
    }
]

5. Обновление нескольких характеристик

Метод: PUT
URL: {domain}/external/specification/bulk-update/

Описание:
Обновляет несколько характеристик одновременно.

Пример запроса:

PUT {domain}/external/specification/bulk-update/
Content-Type: application/json

Тело запроса:

[
    {
        "id": 97,
        "sp_key": "мощностьтыловыхколонок_обновлено",
        "name_ro": "Puterea difuzoarelor spate actualizat",
        "name_ru": "Мощность тыловых колонок обновлено",
        "name_en": "Rear speaker power updated",
        "name_uk": "Потужність тилових колонок оновлено"
    },
    {
        "id": 22,
        "sp_key": "времязарядки_обновлено",
        "name_ro": "TIMP DE ÎNCĂRCARE ACTUALIZAT",
        "name_ru": "ВРЕМЯ ЗАРЯДКИ ОБНОВЛЕНО",
        "name_en": "CHARGE TIME UPDATED",
        "name_uk": "ЧАС ЗАРЯДКИ ОНОВЛЕНО"
    }
]

Пример ответа:

[
    {
        "id": 97,
        "sp_key": "мощностьтыловыхколонок_обновлено",
        "name_ro": "Puterea difuzoarelor spate actualizat",
        "name_ru": "Мощность тыловых колонок обновлено",
        "name_en": "Rear speaker power updated",
        "name_uk": "Потужність тилових колонок оновлено"
    },
    {
        "id": 22,
        "sp_key": "времязарядки_обновлено",
        "name_ro": "TIMP DE ÎNCĂRCARE ACTUALIZAT",
        "name_ru": "ВРЕМЯ ЗАРЯДКИ ОБНОВЛЕНО",
        "name_en": "CHARGE TIME UPDATED",
        "name_uk": "ЧАС ЗАРЯДКИ ОНОВЛЕНО"
    }
]

Примечания:

  • Поле id обязательно для обновления характеристик.
  • Для создания характеристики поле id опускается.
  • Поля с названием характеристики (name_*) можно заполнить только для тех языков, которые нужны в вашей системе. Пустые значения разрешены.
  • Поле sp_key можно опускать и система сгенерирует их автоматически.

Была ли статья полезна?

Да, спасибо! К сожалению, нет

Была ли эта статья полезной?

Оригинал: https://docs.ecom.md/548-558-562-572-573--harakteristiki/