Списки магазинов (филиалов)

Документация API для работы с магазинами (филиалами)

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

Поле Тип Обязательное? Описание
id int Нет Уникальный идентификатор магазина.
lat string Да Географическая широта местоположения магазина.
lon string Да Географическая долгота местоположения магазина.
tooltippintext string Нет Текст для всплывающей подсказки на карте.
email string Нет Электронная почта магазина.
order int Нет Порядковый номер отображения магазина.
description_ro string Нет Описание магазина на румынском языке.
description_ru string Нет Описание магазина на русском языке.
description_en string Нет Описание магазина на английском языке.
description_uk string Нет Описание магазина на украинском языке.
iframe string Нет HTML-фрейм для отображения дополнительных данных, связанных с магазином.
company_id int Нет Идентификатор компании, связанной с магазином. https://admin.ecom.md/ru/admin/users/company/
is_active boolean Да Активен ли магазин (true/false).
phones array Нет Массив телефонов магазина с их идентификаторами (id) и номерами (phone). https://admin.ecom.md/ru/admin/Base_files/phone/
addresses object Да Адрес магазина. Содержит поля: region_id, locality_id, sector_id, address, house, entrance, apartment, zip_code.

1. Получение всех магазинов

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

Описание:
Возвращает список всех магазинов (филиалов) сайта.

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

GET {domain}/external/shop/

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

[
    {
        "id": 333,
        "lat": "47.04425769408643",
        "lon": "28.8317133350053",
        "tooltip_pin_text": "test test",
        "email": "[[email protected]](https://docs.ecom.md/cdn-cgi/l/email-protection)",
        "order": 55,
        "description_ro": null,
        "description_ru": null,
        "description_en": null,
        "description_uk": null,
        "iframe": "",
        "company_id": null,
        "is_active": true,
        "phones": [
            {
                "id": 4,
                "phone": "+373 60 11 11 14"
            },
            {
                "id": 3,
                "phone": "+373 60 11 11 13"
            }
        ],
        "addresses": {
            "region_id": 3,
            "locality_id": 70,
            "sector_id": 10,
            "address": "Vadul lui Voda 78/2",
            "house": null,
            "entrance": null,
            "apartment": null,
            "zip_code": null
        }
    }
]

2. Получение одного магазина

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

Описание:
Возвращает данные одного магазина по его уникальному идентификатору.

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

GET {domain}/external/shop/333/

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

{
    "id": 333,
    "lat": "47.04425769408643",
    "lon": "28.8317133350053",
    "tooltip_pin_text": "test test",
    "email": "[[email protected]](https://docs.ecom.md/cdn-cgi/l/email-protection)",
    "order": 55,
    "description_ro": null,
    "description_ru": null,
    "description_en": null,
    "description_uk": null,
    "iframe": "",
    "company_id": null,
    "is_active": true,
    "phones": [
        {
            "id": 4,
            "phone": "+373 60 11 11 14"
        },
        {
            "id": 3,
            "phone": "+373 60 11 11 13"
        }
    ],
    "addresses": {
        "region_id": 3,
        "locality_id": 70,
        "sector_id": 10,
        "address": "Vadul lui Voda 78/2",
        "house": null,
        "entrance": null,
        "apartment": null,
        "zip_code": null
    }
}

3. Создание нескольких магазинов

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

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

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

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

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

[
    {
        "lat": "47.04425769408643",
        "lon": "28.8317133350053",
        "tooltip_pin_text": "new test shop",
        "email": "[[email protected]](https://docs.ecom.md/cdn-cgi/l/email-protection)",
        "order": 1,
        "description_ro": "Описание на румынском",
        "description_ru": "Описание на русском",
        "description_en": "Description in English",
        "description_uk": "Опис українською",
        "iframe": "",
        "company_id": 1,
        "is_active": true,
        "phones": [
            {
                "id": 1,
                "phone": "+373 60 11 11 11"
            },
            {
                "id": 2,
                "phone": "+373 60 11 11 12"
            }
        ],
        "addresses": {
            "region_id": 4,
            "locality_id": 71,
            "sector_id": 11,
            "address": "Stefan cel Mare 12",
            "house": "1",
            "entrance": "",
            "apartment": "",
            "zip_code": "MD-2020"
        }
    }
]

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

[
    {
        "id": 334,
        "lat": "47.04425769408643",
        "lon": "28.8317133350053",
        "tooltip_pin_text": "new test shop",
        "email": "[[email protected]](https://docs.ecom.md/cdn-cgi/l/email-protection)",
        "order": 1,
        "description_ro": "Описание на румынском",
        "description_ru": "Описание на русском",
        "description_en": "Description in English",
        "description_uk": "Опис українською",
        "iframe": "",
        "company_id": 1,
        "is_active": true,
        "phones": [
            {
                "id": 1,
                "phone": "+373 60 11 11 11"
            },
            {
                "id": 2,
                "phone": "+373 60 11 11 12"
            }
        ],
        "addresses": {
            "region_id": 4,
            "locality_id": 71,
            "sector_id": 11,
            "address": "Stefan cel Mare 12",
            "house": "1",
            "entrance": "",
            "apartment": "",
            "zip_code": "MD-2020"
        }
    }
]

4. Обновление нескольких магазинов

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

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

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

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

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

[
    {
        "id": 333,
        "tooltip_pin_text": "updated shop tooltip",
        "email": "[[email protected]](https://docs.ecom.md/cdn-cgi/l/email-protection)",
        "is_active": false,
        "addresses": {
            "region_id": 3,
            "locality_id": 70,
            "sector_id": 10,
            "address": "Updated Address 78/2"
        }
    },
    {
        "id": 334,
        "tooltip_pin_text": "another shop update",
        "email": "[[email protected]](https://docs.ecom.md/cdn-cgi/l/email-protection)",
        "is_active": true
    }
]

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

[
    {
        "id": 333,
        "tooltip_pin_text": "updated shop tooltip",
        "email": "[[email protected]](https://docs.ecom.md/cdn-cgi/l/email-protection)",
        "is_active": false,
        "addresses": {
            "region_id": 3,
            "locality_id": 70,
            "sector_id": 10,
            "address": "Updated Address 78/2"
        }
    },
    {
        "id": 334,
        "tooltip_pin_text": "another shop update",
        "email": "[[email protected]](https://docs.ecom.md/cdn-cgi/l/email-protection)",
        "is_active": true
    }
]

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

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

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

Оригинал: https://docs.ecom.md/548-558-579--spiski-magazinov-filialov/