Общие товары: master_products

Общие товары - это товары, доступные всем продавцам для продажи. Сущность master_products добавляется модулем Общие товары для продавцов.

URL

http://example.com/api/master_products — обращается ко всем общим товарам.

Поддерживает GET и POST.

http://example.com/api/master_products/:id — обращается к конкретному общему товару по идентификатору (ID).

Поддерживает GET, PUT и DELETE.

Вложенные объекты

Постраничная навигация и сортировка

Параметры сортировки и постраничной навигации полностью наследуются от программных интерфейсов (API) товаров.

Фильтры

Параметры фильтрации полностью наследуются от программных интерфейсов (API) товаров. Модуль Общие товары для продавцов добавляет следующий новый параметр фильтрации, который доступен через программные интерфейсы (API) товаров:

show_master_products_only (bool[true|false]) — фильтр по типу товара, позволяет получить только общие товары либо только товары, принадлежащие продавцам.

Поля

Поля общих товаров полностью наследуются от программных интерфейсов (API) товаров. Модуль Общие товары для продавцов добавляет следующее новое поле, доступное как через программные интерфейсы (API) товаров, так и через программные интерфейсы (API) общих товаров:

master_product_offers_count — количество товарных предложений общего товара.

Примеры

  • Получение списка общих товаров:

    GET /api/master_products/

  • Получение списка общих товаров с сортировкой по возрастанию цены:

    GET /api/master_products?sort_by=price&sort_order=asc

  • Получение списка общих товаров, принадлежащих категории с идентификатором (ID) 1:

    GET /api/categories/1/master_products/

  • Получение данных общего товара с идентификатором (ID) 310:

    GET /api/master_products/310

  • Создание общего товара:

    Запрос

    POST /api/master_products/

    Данные JSON

    {
             "product": "Название общего товара",
             "price": "100",
         "product_code": "12345"
    }
    

    Создание общих товаров доступно только администраторам маркетплейса. Поля product и price являются обязательными.

  • Обновление общего товара c идентификатором (ID) 310:

    Запрос

    PUT /api/master_products/310

    Данные JSON

    {
             "price": "99.90",
             "list_price": "110.00",
             "category_ids": [223]
    }
    
  • Удаление общего товара c идентификатором (ID) 310:

    DELETE /api/master_products/310