Микросервис catalog-orchestration

В статье описываются функции, логика работы, конфигурация и методы микросервиса catalog-orchestration.

Микросервис catalog-orchestration используется для управления каталогом (каталогами, категориями, товарами, медиа ассетами и характеристиками).

Доступ к сервису предоставляется по запросу.

В работе микросервиса участвуют следующие сущности:

  • Медиа ассет (Media Asset) - содержит информацию о медиа (id, название, url на соответствующем внешнем ресурсе, описание, теги и др.)
  • Категория (Category) - содержит информацию о категории (id, название, url, медиа, характеристики, уровень в иерархии категорий и др.)
  • Характеристика (Feature) - содержит информацию о характеристике продукта или варианта продукта (id, название, значения характеристики и др.)
  • Продукт (Product) - содержит информацию о продукте (id, название, варианты товара, характеристики, медиа ассеты, категория и др.)
  • Каталог (Catalog) - содержит данные о каталоге (id, название и привязанные категории)

При обращении к микросервису через API для выполнения следующих запросов необходимо использовать токен, который следует указать в заголовке Authorization:

  • работа с каталогами:
    • создание нового каталога - POST запрос, /v2/catalogs;
    • редактирование каталога - PATCH запрос, /v2/catalogs/{id};
    • удаление каталога - DELETE запрос, /v2/catalogs/{id};
  • работа с категориями:
    • создание категории - POST запрос, /v2/categories;
    • создание категории - POST запрос, /v1/categories;
    • редактирование категории - PATCH запрос, /v2/categories/{id};
    • редактирование категории - PATCH запрос, /v1/categories/{id};
    • удаление категории - DELETE запрос, /v2/categories/{id};
  • работа с товарами и их вариантами:
    • создание товара - POST запрос, /v2/products;
    • редактирование товара - PATCH запрос, /v2/products/{id};
    • редактирование товара - PATCH запрос, /v2/products/.

Для остальных запросов аутентификация не требуется.

/api/catalog-orchestration/

Параметры конфигурации указываются в Vault.

Vault используется на нашей платформе в качестве хранилища всех конфигураций развертывания. Инструмент может быть выбран другой.

По умолчанию

{
  "env": {
    "JAVA_XMS": "ХХm",
    "JAVA_XMX": "YYYm"

  }
}
Copy-icon
Указываемые на каждом отдельном стенде

// пример взят с тестового стенда


{
  "env": {
    "AUTH_ENABLED": "флаг активации аутентификации",
    "KAFKA_BROKER_ADDRESS": "сокет_брокера_kafka",

    "OAUTH_ECOM_CLIENT_ID": "токен_приложения_ECOM_OAuth",
    "OAUTH_ECOM_ISSUER_URI": "url_ECOM_OAuth",
    "OAUTH_ZITADEL_CLIENT_ID": "токен_приложения_Zitadel",
    "OAUTH_ZITADEL_ISSUER_URI": "url_Zitadel",
    "REDIS_HOST": "хост_redis",
    "REDIS_PORT": "порт_redis"
  }
}
Copy-icon

Методы микросервиса Copy-icon

Работа с медиа ассетами Copy-icon

  • Получение страницы с медиа ассетами - GET запрос, /v1/assets
Request parameters

page - query-параметр: номер страницы
size - query-параметр: размер страницы
sort - query-параметр: сортировка страницы
Copy-icon
Response sample

{
  "content": [
    {
      "id": "64a3fa07abdf6269e7453ef2",
      "media": {
        "url": "master/catalog/images/1688467951414-1882559365.png",
        "name": "01-1.png",
        "type": "PHOTO",
        "size": 137858,
        "resolution": "427x427 px",
        "createdDate": "2023-07-04T13:52:55.273"
      },
      "title": "Фитнес-перчатки",
      "altAttr": "Фитнес-перчатки",
      "description": "12311",
      "sign": "12311",
      "tags": [
        "12311"
      ]
    },
    {
      "id": "e1a0ee88-63a4-4d64-b233-6266ba784ae9",
      "media": {
        "url": "master/catalog/images/900_1200/1707735229989-1882559365.jpg",
        "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/900_1200/1707735229989-1882559365.jpg",
        "name": "02-002-pic.jpg",
        "type": "PHOTO",
        "size": 39944,
        "resolution": "900x1200px",
        "createdDate": "2024-02-12T13:53:58.273"
      },
      "title": "02-002-pic",
      "altAttr": "02-002-pic",
      "description": "",
      "sign": "",
      "tags": [
        ""
      ]
    },
    {
      "id": "2281de2d-bc1e-4fca-8434-a276f7fa19b3",
      "media": {
        "url": "master/catalog/images/1703075793230-1882559365.jpg",
        "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1703075793230-1882559365.jpg",
        "name": "05-3583-10.jpg",
        "type": "PHOTO",
        "size": 127125,
        "resolution": "800x1097 px",
        "createdDate": "2023-12-20T15:37:04.824"
      },
      "title": "брюки синие",
      "altAttr": "брюки синие",
      "description": "",
      "sign": "",
      "tags": [
        ""
      ]
    }
  ],
  "number": 0,
  "size": 3,
  "totalElements": 359,
  "pageable": "INSTANCE",
  "last": false,
  "totalPages": 120,
  "sort": {
    "unsorted": true,
    "sorted": false,
    "empty": true
  },
  "first": true,
  "numberOfElements": 3,
  "empty": false
}
Copy-icon
Response codes

200 - успешно прошла операция, получена страница с медиа ассетами

  • Получение медиа ассета по его ID - GET запрос, /v1/assets/{id}
Request parameters

id - path-параметр, обязательный: уникальный идентификатор медиа ассета
Copy-icon
Response sample

{
  "id": "527e30ce-8891-4049-9b36-265ef179e07e",
  "media": {
    "url": "master/catalog/images/1714574818873-1882559365.jpg",
    "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1714574818873-1882559365.jpg",
    "name": "krasivye-kartinki-kotikov-55.jpg",
    "type": "PHOTO",
    "size": 427989,
    "resolution": "1805x1128 px",
    "createdDate": "2024-05-01T17:47:08.871"
  },
  "title": "krasivye-kartinki-kotikov-5511",
  "altAttr": "krasivye-kartinki-kotikov-5511",
  "description": "",
  "sign": "",
  "tags": [
    ""
  ]
}
Copy-icon
Response codes
  • 200 - операция выполнена успешно, получены данные медиа ассета
  • 404 - ошибка, медиа ассет не найден
  • Получение списка медиа ассетов (с учетом пагинации, сортировки и фильтров) - POST запрос, /v1/assets/filter
Request body

{
    "sort": [
        {
            "sortBy": "media.createdDate",
            "direction": "desc"
        }
    ],
    "page": 0,
    "size": 10,
    "filter": {
        "searchTerm": "",
        "name": {
            "value": "kot"
        },
        "type": {
            "value": "photo"
        },
        "resolution": {
            "value": ""
        },
        "size": {
            "value": "417"
        },
        "createdDate": {
            "start": "2024-04-26T00:00:00",
            "end": ""
        }
    }
}
Copy-icon
Response sample

{
  "content": [
    {
      "id": "527e30ce-8891-4049-9b36-265ef179e07e",
      "media": {
        "url": "master/catalog/images/1714574818873-1882559365.jpg",
        "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1714574818873-1882559365.jpg",
        "name": "krasivye-kartinki-kotikov-55.jpg",
        "type": "PHOTO",
        "size": 427989,
        "resolution": "1805x1128 px",
        "createdDate": "2024-05-01T17:47:08.871"
      },
      "title": "krasivye-kartinki-kotikov-5511",
      "altAttr": "krasivye-kartinki-kotikov-5511",
      "description": "",
      "sign": "",
      "tags": [
        ""
      ]
    },
    {
      "id": "26002942-9a8d-44c6-a70d-1486cdc6b872",
      "media": {
        "url": "master/catalog/images/1714113158689-1882559365.jpg",
        "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1714113158689-1882559365.jpg",
        "name": "krasivye-kartinki-kotikov-55.jpg",
        "type": "PHOTO",
        "size": 427989,
        "resolution": "1805x1128 px",
        "createdDate": "2024-04-26T09:32:45.459"
      },
      "title": "krasivye-kartinki-kotikov-55",
      "altAttr": "krasivye-kartinki-kotikov-55",
      "description": "кросивое",
      "sign": "test",
      "tags": [
        ""
      ]
    },
    {
      "id": "64b7fadfb5a7960e96b3105f",
      "media": {
        "url": "master/catalog/images/1689778904856-1882559365.jpg",
        "name": "1250-666-porodista-kotka.jpg",
        "type": "PHOTO",
        "size": 78393,
        "resolution": "1250x666 px",
        "createdDate": "2023-07-19T18:01:51.515"
      },
      "title": "тест",
      "altAttr": "кошка123",
      "description": "",
      "sign": "",
      "tags": [
        ""
      ]
    },
    {
      "id": "64b15f63460ae8511a0e7255",
      "media": {
        "url": "master/catalog/images/1689345881306-1882559365.jpg",
        "name": "1250-666-porodista-kotka.jpg",
        "type": "PHOTO",
        "size": 78393,
        "resolution": "1250x666 px",
        "createdDate": "2023-07-14T17:44:51.198"
      },
      "title": "1",
      "altAttr": "1",
      "description": "",
      "sign": "",
      "tags": [
        ""
      ]
    }
  ],
  "number": 0,
  "size": 4,
  "totalElements": 4,
  "pageable": "INSTANCE",
  "last": true,
  "totalPages": 1,
  "sort": {
    "unsorted": true,
    "sorted": false,
    "empty": true
  },
  "first": true,
  "numberOfElements": 4,
  "empty": false
}
Copy-icon
Response codes

200 - операция выполнена успешно, получен отфильтрованный список медиа ассетов

  • Редактирование медиа ассета - PATCH запрос, /v1/assets/{id}
Request parameters

id - path-параметр, обязательный: уникальный идентификатор медиа ассета
Copy-icon
Request body sample

{
    "url": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1714113158689-1882559365.jpg",
    "name": "krasivye-kartinki-kotikov-55.jpg",
    "resolution": "1805x1128 px",
    "size": 427989,
    "title": "krasivye-kartinki-kotikov-55",
    "altAttr": "krasivye-kartinki-kotikov-55",
    "description": "кросивое",
    "sign": "test",
    "tags": [
        ""
    ]
}
Copy-icon
Response sample

{
    "id": "26002942-9a8d-44c6-a70d-1486cdc6b872",
    "media": {
        "url": "master/catalog/images/1714113158689-1882559365.jpg",
        "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1714113158689-1882559365.jpg",
        "name": "krasivye-kartinki-kotikov-55.jpg",
        "type": "PHOTO",
        "size": 427989,
        "resolution": "1805x1128 px",
        "createdDate": "2024-04-26T09:32:45.459"
    },
    "title": "krasivye-kartinki-kotikov-55",
    "altAttr": "krasivye-kartinki-kotikov-55",
    "description": "кросивое",
    "sign": "test",
    "tags": [
        ""
    ]
}
Copy-icon
Response codes
  • 202 - медиа ассет успешно отредактирован
  • 404 - медиа ассет с таким ID не найден
  • Создание медиа ассета - POST запрос, /v1/assets
Request parameters

attachToVariant -query-параметр: флаг активации добавления медиа ассета к вариантам товара
Copy-icon
Request body sample

{
    "url": "master/catalog/images/1714123859727-1882559365.jfif",
    "name": "productImage.jfif",
    "resolution": "720x720 px",
    "extension": "jpeg",
    "size": 28008,
    "title": "новаяСумочка",
    "altAttr": "newBag",
    "description": "Очень качественная сумка",
    "sign": "",
    "tags": [
        ""
    ]
}
Copy-icon
Response sample

{
  "id": "48388674-1d35-40c6-96f6-3c3b09a6cce3",
  "media": {
    "url": "master/catalog/images/1714123859727-1882559365.jfif",
    "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1714123859727-1882559365.jfif",
    "name": "productImage.jfif",
    "type": "PHOTO",
    "size": 28008,
    "resolution": "720x720 px",
    "createdDate": "2024-05-23T16:57:51.913429"
  },
  "title": "новаяСумочка",
  "altAttr": "newBag",
  "description": "Очень качественная сумка",
  "sign": "",
  "tags": [
    ""
  ]
}
Copy-icon
Response codes

201 - медиа ассет успешно создан

  • Удаление медиа ассета - DELETE запрос, /v1/assets/{id}
Request parameters

id - path-параметр, обязательный: уникальный идентификатор медиа ассета
Copy-icon
Response sample

Отсутствует. В ответе приходит только код операции, например, 204.

Response codes
  • 204 - операция выполнена успешно, медиа ассет удален
  • 404 - ошибка, медиа ассет не найден
  • Получение категории по ее ID - GET запрос, /v1/categories/{id}
Request parameters

id - path-параметр, обязательный: уникальный идентификатор категории
parents - query-параметр: флаг активации получения данных родительской категории
Copy-icon
Response sample

{
  "id": "cat1001216DC",
  "name": "iPhone",
  "title": "iPhone",
  "url": "/iPhone",
  "media": {
    "id": "527e30ce-8891-4049-9b36-265ef179e07e",
    "media": {
      "url": "master/catalog/images/1714574818873-1882559365.jpg",
      "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1714574818873-1882559365.jpg",
      "name": "krasivye-kartinki-kotikov-55.jpg",
      "type": "PHOTO",
      "size": 427989,
      "resolution": "1805x1128 px",
      "createdDate": "2024-05-01T17:47:08.871"
    },
    "title": "krasivye-kartinki-kotikov-5511",
    "altAttr": "krasivye-kartinki-kotikov-5511",
    "description": "",
    "sign": "",
    "tags": [
      ""
    ]
  },
  "features": [
    {
      "id": "f1000105DC",
      "name": "Версия ОС на начало продаж",
      "values": [
        "",
        " iOS 17"
      ],
      "createdDate": "2024-01-17T14:18:37.961"
    },
    {
      "id": "f1000106DC",
      "name": "Тип корпуса",
      "values": [
        "",
        "классический",
        "оригинальный"
      ],
      "createdDate": "2024-01-17T14:18:48.452"
    },
    {
      "id": "f1000107DC",
      "name": "Дисплей",
      "values": [
        "",
        " 6.1\" (2556x1179), 2K QHD, OLED",
        "7.2"
      ],
      "createdDate": "2024-01-17T14:19:08.695"
    },
    {
      "id": "f1000108DC",
      "name": "Особенности экрана",
      "values": [
        "",
        "Dynamic Island, сенсорный экран, устойчивое к царапинам стекло, цветной экран"
      ],
      "createdDate": "2024-01-17T14:19:21.77"
    },
    {
      "id": "f1000109DC",
      "name": "Функции камеры",
      "values": [
        "",
        "автофокусировка, оптическая стабилизация, основная камера, тыловая вспышка, фронтальная камера"
      ],
      "createdDate": "2024-01-17T14:19:38.424"
    }
  ],
  "type": "WITH_PRODUCTS",
  "parentCategoryId": "cat1000209DC",
  "level": 2,
  "order": 40,
  "seo": {
    "title": "Глобальный Шаблон title %name-category%",
    "keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
    "description": "Глобальный шаблон description %name-product% в %name-category%  от %price-min% до %price-max%"
  },
  "catalogId": "master-catalog",
  "parentCategory": {
    "id": "cat1000209DC",
    "name": "Смартфоны",
    "title": "Смартфоны",
    "url": "/Smartfony",
    "media": {
      "id": "df4dc6ea-e0cf-4a1f-b63d-02087348965a",
      "media": {
        "url": "master/catalog/images/1714124906917-1882559365.jfif",
        "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1714124906917-1882559365.jfif",
        "name": "productImage.jfif",
        "type": "PHOTO",
        "size": 28008,
        "resolution": "720x720 px",
        "createdDate": "2024-04-26T12:48:33.794"
      },
      "title": "productImage",
      "altAttr": "productImage",
      "description": "",
      "sign": "",
      "tags": [
        ""
      ]
    },
    "features": [],
    "type": "NO_PRODUCTS",
    "parentCategoryId": null,
    "level": 1,
    "order": 34,
    "seo": {
      "title": "Свой Шаблон title %name-category%",
      "keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
      "description": "Глобальный шаблон description %name-product% в %name-category%  от %price-min% до %price-max%"
    },
    "catalogId": "master-catalog"
  }
}
Copy-icon
Response codes
  • 200 - операция выполнена успешно, получены данные категории
  • 404 - ошибка, категория не найдена
  • Получение отфильтрованного дерева категорий - POST запрос, /v1/categories/tree
Request body sample

{
    "searchTerm": "муж",
    "catalogId": "c1000025DC"
}
Copy-icon
Response sample

{
  "children": [
    {
      "children": [
        {
          "children": [],
          "id": "cat1007797DC",
          "name": "Одежда для мужчин",
          "title": "Одежда для мужчин",
          "url": "/Odezhda-dlya-muzhchin",
          "features": [],
          "type": "WITH_PRODUCTS",
          "level": 2,
          "order": 46,
          "seo": {
            "title": "Глобальный Шаблон 2 title %name-category%",
            "keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
            "description": "Глобальный шаблон description %name-product% в %name-category%  от %price-min% до %price-max%"
          },
          "parentCategoryId": "cat1007790DC",
          "catalogId": "c1000025DC"
        }
      ],
      "id": "cat1007790DC",
      "name": "Одежда",
      "title": "Одежда",
      "url": "/Odezhda",
      "features": [],
      "type": "NO_PRODUCTS",
      "level": 1,
      "order": 86,
      "seo": {
        "title": "Глобальный Шаблон 2 title %name-category%",
        "keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
        "description": "Глобальный шаблон description %name-product% в %name-category%  от %price-min% до %price-max%"
      },
      "parentCategoryId": "",
      "catalogId": "c1000025DC"
    }
  ]
}
Copy-icon
Response codes

200 - операция выполнена успешно, получен отфильтрованный список категорий

  • Изменение порядка категорий - PATCH запрос, /v2/categories/change-order
Request body sample

{
    "firstCategoryId": "cat1000175DC",
    "secondCategoryId": "cat1000209DC",
    "catalogId": ""
}
Copy-icon
Response sample

Возвращает дерево категорий.

Response codes
  • 200 - операция выполнена успешно, изменен порядок категорий
  • 400 - ошибка, категории должны быть одного и того же уровня
  • 404 - ошибка, категория не найдена
  • Поиск категории по ее названию - GET запрос, /v1/categories/find-by-name/{name}
Request parameters

name - path-параметр, обязательный: имя категории
catalogId - query-параметр: ID каталога
Copy-icon
Response sample

[
  {
    "id": "cat1007798DC",
    "name": "Одежда для женщин",
    "title": "Одежда для женщин",
    "url": "/Odezhda-dlya-zhenshchin",
    "features": [],
    "type": "WITH_PRODUCTS",
    "parentCategoryId": "cat1007790DC",
    "level": 2,
    "order": 45,
    "seo": {
      "title": "Глобальный Шаблон 2 title %name-category%",
      "keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
      "description": "Глобальный шаблон description %name-product% в %name-category%  от %price-min% до %price-max%"
    },
    "catalogId": "c1000025DC"
  }
]
Copy-icon
Response codes
  • 200 - операция выполнена успешно, возвращена категория с соответствующим именем
  • 404 - ошибка, категория с таким именем не найдена
  • Поиск родительской категории по ее названию - GET запрос, /v1/categories/find-parent-by-name/{name} 
Request parameters

name - path-параметр, обязательный: имя родительской категории
Copy-icon
Response sample

[
  {
    "id": "cat1000209DC",
    "name": "Смартфоны",
    "title": "Смартфоны",
    "url": "/Smartfony",
    "media": {
      "id": "df4dc6ea-e0cf-4a1f-b63d-02087348965a",
      "media": {
        "url": "master/catalog/images/1714124906917-1882559365.jfif",
        "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1714124906917-1882559365.jfif",
        "name": "productImage.jfif",
        "type": "PHOTO",
        "size": 28008,
        "resolution": "720x720 px",
        "createdDate": "2024-04-26T12:48:33.794"
      },
      "title": "productImage",
      "altAttr": "productImage",
      "description": "",
      "sign": "",
      "tags": [
        ""
      ]
    },
    "features": [],
    "type": "NO_PRODUCTS",
    "parentCategoryId": null,
    "level": 1,
    "order": 34,
    "seo": {
      "title": "Свой Шаблон title %name-category%",
      "keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
      "description": "Глобальный шаблон description %name-product% в %name-category%  от %price-min% до %price-max%"
    },
    "catalogId": "master-catalog"
  }
]
Copy-icon
Response codes
  • 200 - операция выполнена успешно, возвращена категория с соответствующим именем
  • 404 - ошибка, категория с таким именем не найдена
  • Создание категории - POST запрос, /v2/categories
Request body sample

{
    "name": "Одежда",
    "url": "/Odezhda",
    "parentCategoryId": "",
    "mediaAssetId": "",
    "type": "NO_PRODUCTS",
    "seo": {
        "title": "",
        "keywords": "",
        "description": ""
    },
    "catalogId": "c1000025DC",
    "featureIds": []
}
Copy-icon
Response sample

Отсутствует.

Response codes

201 - категория успешно создана

  • Создание категории - POST запрос, /v1/categories
Request body sample

{
    "name": "Для подростков",
    "url": "/Dlya-podrostkov",
    "parentCategoryId": "cat1000224DC",
    "mediaAssetId": "",
    "type": "WITH_PRODUCTS",
    "seo": {
        "title": "",
        "keywords": "",
        "description": ""
    },
    "catalogId": "c1000025DC",
    "featureIds": [
        "f1000005DC"
    ]
}
Copy-icon
Response sample

{
    "id": "cat1007770DC",
    "name": "Для подростков",
    "title": "Для подростков",
    "url": "/Dlya-podrostkov",
    "media": null,
    "type": "WITH_PRODUCTS",
    "parentCategoryId": "cat1000224DC",
    "features": [
        {
            "id": "f1000005DC",
            "name": "Страна производства",
            "values": [
                "",
                "Россия",
                "Малайзия",
                "Узбекистан",
                "Канада",
                "Беларусь",
                "Китай",
                "Турция",
                "Индия",
                "Япония",
                "Бразилия"
            ]
        }
    ],
    "level": 2,
    "order": 44,
    "seo": {
        "title": "",
        "keywords": "",
        "description": ""
    },
    "catalogId": "c1000025DC"
}
Copy-icon
Response codes

201 - категория успешно создана

  • Редактирование категории - PATCH запрос, /v2/categories/{id}
Request parameters

id - path-параметр, обязательный: идентификатор категории
Copy-icon
Request body sample

{
    "name": "Одежда",
    "url": "/Odezhda",
    "parentCategoryId": "",
    "mediaAssetId": "",
    "type": "WITH_PRODUCTS",
    "seo": {
        "title": "Глобальный Шаблон 2 title %name-category%",
        "keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
        "description": "Глобальный шаблон description %name-product% в %name-category%  от %price-min% до %price-max%"
    },
    "catalogId": "c1000025DC",
    "featureIds": []
}
Copy-icon
Response sample

Отсутствует.

Response codes
  • 202 - категория успешно отредактирована
  • 204 - No Content
  • 404 - категория не найдена
  • Редактирование категории - PATCH запрос, /v1/categories/{id}
Request parameters

id - path-параметр, обязательный: уникальный идентификатор категории
Copy-icon
Request body sample

{
    "name": "Одежда детская"
}
Copy-icon
Response sample

{
    "name": "Одежда детская",
    "url": "/Odezhda",
    "parentCategoryId": "",
    "mediaAssetId": "",
    "type": "WITH_PRODUCTS",
    "seo": {
        "title": "Глобальный Шаблон 2 title %name-category%",
        "keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
        "description": "Глобальный шаблон description %name-product% в %name-category%  от %price-min% до %price-max%"
    },
    "catalogId": "c1000025DC",
    "featureIds": []
}
Copy-icon
Response codes
  • 202 - категория успешно отредактирована
  • 404 - категория не найдена
  • Удаление категории - DELETE запрос, /v1/categories/{id}
Request parameters

id - path-параметр, обязательный: идентификатор категории
Copy-icon
Response sample

Отсутствует. В ответе приходит только код операции, например, 204.

Response codes
  • 204 - операция выполнена успешно, категория удалена
  • 404 - ошибка, не удалось найти категорию
  • Получение отфильтрованного дерева категорий (grpc) - POST запрос, /v2/categories/tree
Request parameters

Отсутствуют.

Request body sample

{
  "catalogId": "c1000002DC",
  "typeSet": [
    "WITH_PRODUCTS"
  ]
}
Copy-icon
Response sample 
{
  "children": [
    {
      "children": [
        {
          "children": [
            {
              "children": [],
              "id": "cat1025895DC",
              "name": "Одежда",
              "title": "Одежда",
              "url": "/odezhda",
              "media": {
                "id": "d8bebe28-5a6d-4f25-9c05-680a0bcf6080",
                "media": {
                  "url": "master/catalog/images/1715076260063-1882559365.jpg",
                  "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1715076260063-1882559365.jpg",
                  "name": "Китай (флаг).jpg",
                  "type": "PHOTO",
                  "size": 9712,
                  "resolution": "612x407 px",
                  "createdDate": "2024-05-07T13:04:38.167"
                },
                "title": "Китай (флаг)",
                "altAttr": "Китай (флаг)",
                "description": "",
                "sign": "",
                "tags": [
                  ""
                ]
              },
              "features": [
                {
                  "id": "f1000004DC",
                  "name": "Рост модели",
                  "values": [
                    "170см",
                    "175"
                  ],
                  "createdDate": "2024-07-31T15:24:10.793"
                },
                {
                  "id": "f1000005DC",
                  "name": "Страна производства",
                  "values": [
                    "",
                    "Россия",
                    "Малайзия",
                    "Узбекистан",
                    "Канада",
                    "Беларусь",
                    "Китай",
                    "Турция",
                    "Индия",
                    "Япония",
                    "Бразилия"
                  ],
                  "createdDate": "2024-07-31T15:24:10.793"
                },
                {
                  "id": "f1000006DC",
                  "name": "Высота упаковки",
                  "values": [
                    "50 см",
                    "40 см",
                    "60 см",
                    ""
                  ],
                  "createdDate": "2024-07-31T15:24:10.793"
                },
                {
                  "id": "f1000007DC",
                  "name": "Ширина упаковки",
                  "values": [
                    "14 см",
                    "10 см",
                    "20 см",
                    ""
                  ],
                  "createdDate": "2024-07-31T15:24:10.793"
                }
              ],
              "type": "WITH_PRODUCTS",
              "level": 3,
              "order": 23,
              "seo": {
                "title": "Глобальный Шаблон 2 title %name-category%",
                "keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
                "description": "Глобальный шаблон description %name-product% в %name-category%  от %price-min% до %price-max%"
              },
              "parentCategoryId": "cat1007835DC",
              "catalogId": "c1000002DC"
            }
          ],
          "id": "cat1007835DC",
          "name": "Обувь",
          "title": "Обувь",
          "url": "/obuv",
          "media": {
            "id": "d8bebe28-5a6d-4f25-9c05-680a0bcf6080",
            "media": {
              "url": "master/catalog/images/1715076260063-1882559365.jpg",
              "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1715076260063-1882559365.jpg",
              "name": "Китай (флаг).jpg",
              "type": "PHOTO",
              "size": 9712,
              "resolution": "612x407 px",
              "createdDate": "2024-05-07T13:04:38.167"
            },
            "title": "Китай (флаг)",
            "altAttr": "Китай (флаг)",
            "description": "",
            "sign": "",
            "tags": [
              ""
            ]
          },
          "features": [],
          "type": "WITH_PRODUCTS",
          "level": 2,
          "order": 49,
          "seo": {
            "title": "Глобальный Шаблон 2 title %name-category%",
            "keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
            "description": "Глобальный шаблон description %name-product% в %name-category%  от %price-min% до %price-max%"
          },
          "parentCategoryId": "cat1007834DC",
          "catalogId": "c1000002DC"
        }
      ],
      "id": "cat1007834DC",
      "name": "Сумки",
      "title": "Сумки",
      "url": "/sumki",
      "media": {
        "id": "d8bebe28-5a6d-4f25-9c05-680a0bcf6080",
        "media": {
          "url": "master/catalog/images/1715076260063-1882559365.jpg",
          "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1715076260063-1882559365.jpg",
          "name": "Китай (флаг).jpg",
          "type": "PHOTO",
          "size": 9712,
          "resolution": "612x407 px",
          "createdDate": "2024-05-07T13:04:38.167"
        },
        "title": "Китай (флаг)",
        "altAttr": "Китай (флаг)",
        "description": "",
        "sign": "",
        "tags": [
          ""
        ]
      },
      "features": [
        {
          "id": "f1021147DC",
          "name": "тип продукта",
          "values": [
            "234",
            "5"
          ],
          "createdDate": "2024-08-19T14:17:14.852"
        },
        {
          "id": "f1000004DC",
          "name": "Рост модели",
          "values": [
            "170см",
            "175"
          ],
          "createdDate": "2024-07-31T15:24:10.793"
        },
        {
          "id": "f1000005DC",
          "name": "Страна производства",
          "values": [
            "",
            "Россия",
            "Малайзия",
            "Узбекистан",
            "Канада",
            "Беларусь",
            "Китай",
            "Турция",
            "Индия",
            "Япония",
            "Бразилия"
          ],
          "createdDate": "2024-07-31T15:24:10.793"
        }
      ],
      "type": "WITH_PRODUCTS",
      "level": 1,
      "order": 49,
      "seo": {
        "title": "Глобальный Шаблон 2 title %name-category%",
        "keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
        "description": "Глобальный шаблон description %name-product% в %name-category%  от %price-min% до %price-max%"
      },
      "parentCategoryId": "",
      "catalogId": "c1000002DC"
    }
  ]
}
Copy-icon
Response codes

200 - операция выполнена успешно, получено дерево категорий

  • Создание характеристики - POST запрос, /v2/features
Request parameters

Отсутствуют.

Request body sample

{
    "name": "Сезон",
    "type": "TEXT",
    "key": "key123",
    "filtering": true,
    "multiValue": true
}
Copy-icon
Response sample

Отсутствует. В ответе приходит только код операции, например, 201.

Response codes
  • 201 - операция выполнена успешно, характеристика создана
  • 409 - ошибка, характеристика с таким именем уже существует
  • Получение страницы с характеристиками - POST запрос, /v1/features/page
Request parameters

Отсутствуют.

Request body sample

{
    "page": 0,
    "size": 10,
    "sort": [
        {
            "sortBy": "type",
            "direction": "desc"
        }
    ],
    "filter": {
        "searchTerm": "",
        "name": "",
        "key": "",
        "typeSet": [],
        "filtering": ""
    }
}
Copy-icon
Response codes

200 - операция выполнена успешно, получена страница со списком характеристик

Response sample

12
Copy-icon
  • Получение списка характеристик (с возможностью фильтрации) - POST запрос, /v1/features/list
Request parameters

Отсутствуют.

Request body sample

{
    "searchTerm": "",
    "name": "рост",
    "key": "",
    "typeSet": [
        "TEXT"
    ],
    "filtering": ""
}
Copy-icon
Response sample

[
   {
      "id":"f1000004DC",
      "name":"Рост модели",
      "type":"TEXT",
      "filtering":true,
      "multiValue":false,
      "values":[
         "67",
         "string",
         "170см",
         "Green",
         "175"
      ],
      "createdDate":"2024-09-18T15:50:24.906"
   },
   {
      "id":"f1000082DC",
      "name":"Рост",
      "type":"TEXT",
      "filtering":true,
      "multiValue":false,
      "values":[
         null,
         "",
         "string",
         "150",
         "140",
         "130",
         "Green",
         "120"
      ],
      "createdDate":"2024-09-18T15:50:24.906"
   }
]
Copy-icon
Response codes

200 - операция выполнена успешно, получен отфильтрованный список характеристик

  • Редактирование характеристики - PATCH запрос, /v2/features/{id}
Request parameters

id - path-параметр, обязательный: уникальный идентификатор характеристики
Copy-icon
Request body sample

{
    "name": "Состав",
    "type": "TEXT",
    "key": "key123",
    "filtering": true,
    "multiValue": false
}
Copy-icon
Response sample

Отсутствует. В ответе приходит только код операции, например, 204.

Response codes
  • 204 - операция выполнена успешно, характеристика обновлена
  • 404 - ошибка, характеристика с таким id не найдена
  • 409 - ошибка, конфликт
  • Получение списка значений характеристики - GET запрос, /v1/features/{id}/values/filter
Request parameters

id - path-параметр,обязательный: уникальный идентификатор характеристики
term - query-параметр: значение характеристики для поиска
Copy-icon
Response sample

[
    "12",
    "45"
]
Copy-icon
Response codes
  • 200 - операция выполнена успешно, получен список значений характеристики
  • 404 - ошибка, характеристика не найдена
  • Удаление характеристики - DELETE запрос, /v1/features/{id}
Request parameters

id - path-параметр,обязательный: уникальный идентификатор характеристики
Copy-icon
Response sample

Отсутствует. В ответе приходит только код операции, например, 204.

Response codes
  • 204 - операция выполнена успешно, характеристика удалена
  • 404 - ошибка, характеристика не найдена
  • Получение характеристики по ее ID - GET запрос, /v1/features/{id}
Request parameters

id - path-параметр, обязательный: уникальный идентификатор характеристики
Copy-icon
Response sample

{
    "id": "f1000016DC",
    "name": "Состав",
    "type": "TEXT",
    "filtering": true,
    "multiValue": false,
    "values": [
        null,
        "",
        "80% хлопок, 20% полиэстер",
        "Металл",
        "40% шерсть, 20% акрил, 5% эластан, 30% вискоза, 5% полиэстер",
        "Пластик",
        "пр.натуральный нубук;пр.натуральная замша",
        "95% спирт",
        "100% полиэстер",
        "95% хлопок, 5% эластан"
    ],
    "createdDate": "2024-09-18T15:50:24.906"
}
Copy-icon
Response codes
  • 200 - операция выполнена успешно, получены данные характеристики
  • 404 - ошибка, характеристика с таким id не найден
  • Получение единиц измерения характеристики - GET запрос, /v1/features/measurements/list
Request parameters

term - query-параметр: название единицы измерения
Copy-icon
Response sample

[
  "mm",
  "Mm",
  "sm",
  "Dm"
]
Copy-icon
Response codes

200 - операция выполнена успешно, получены единицы измерения

Работа с каталогами Copy-icon

  • Получение каталога по его ID - GET запрос, /v2/catalogs/{id}
Request parameters

id - path-параметр, обязательный: ID каталога
Copy-icon
Response sample

{
  "id": "c1000099DC",
  "name": "catalog_Беларусь",
  "categoryIds": [
    "cat1007760DC"
  ]
}
Copy-icon
Response codes
  • 200 - операция успешно выполнена, получены данные каталога
  • 404 - ошибка, каталог с таким ID не найден
  • Создание каталога - POST запрос, /v2/catalogs
Request body sample

{
  "name": "Рынок Узбекистан",
  "categoryIds": [
    "cat1007760DC"
  ]
}
Copy-icon
Response sample

{
  "id": "c1000022DC",
  "name": "Рынок Узбекистан",
  "categoryIds": [
    "cat1007760DC"
  ]
}
Copy-icon
Response codes

200 - операция успешно выполнена, каталог создан

  • Редактирование каталога - PATCH запрос, /v2/catalogs/{id}
Request parameters

id - path-параметр, обязательный: ID каталога
Copy-icon
Request body sample

{
  "name": "Рынок Казахстан"
}
Copy-icon
Response sample

{
  "id": "c1000022DC",
  "name": "Рынок Казахстан",
  "categoryIds": [
    "cat1007760DC"
  ]
}
Copy-icon
Response codes

200 - операция выполнена успешно, каталог обновлен

  • Удаление каталога - DELETE запрос, /v2/catalogs/{id}
Request parameters

id - path-параметр, обязательный: ID каталога
Copy-icon
Response sample

В ответе приходит только код операции, например, 404.

Response codes
  • 200 - операция успешно выполнена, каталог удален
  • 404 - ошибка, каталог с таким ID не найден

Работа с товарами Copy-icon

  • Получение страницы с товарами (с возможностью поиска и фильтрации) - POST запрос, /v1/products/page
Request parameters

extended - query-параметр: флаг, который указывает, нужно ли возвращать товары вместе с ценами и остатками
Copy-icon
Request body sample

{
  "sort": [
    {
      "sortBy": "articleId",
      "direction": "ASC"
    }
  ],
  "page": 0,
  "size": 2,
  "filter": {
    "searchTerm": "шорты"
  }
}
Copy-icon
Response sample

{
  "content": [
    {
      "id": "1001682DC",
      "name": "Шорты женские",
      "seo": {
        "title": "%name-product% ",
        "keywords": "глобальный шаблон keywords %name-product% ",
        "description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"
      },
      "description": "",
      "assets": [
        {
          "id": "f33adc90-ce9c-45ba-ae16-cfa998808dc9",
          "media": {
            "url": "master/catalog/images/1707916795372-1882559365.jpeg",
            "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1707916795372-1882559365.jpeg",
            "name": "1690990851840-1882559365.jpeg",
            "type": "PHOTO",
            "size": 72141,
            "resolution": "900x1200 px",
            "createdDate": "2024-02-14T16:20:04.157"
          },
          "title": "1690990851840-1882559365",
          "altAttr": "1690990851840-1882559365",
          "description": "",
          "sign": "",
          "tags": [
            ""
          ]
        }
      ],
      "features": [
        {
          "featureId": "f1000116DC",
          "name": "Сезон",
          "indexable": true,
          "value": ""
        },
        {
          "featureId": "f1000117DC",
          "name": "Вид застежки",
          "indexable": true,
          "value": ""
        },
        {
          "featureId": "f1000093DC",
          "name": "Бренд",
          "indexable": true,
          "value": ""
        }
      ],
      "category": {
        "id": "cat1000225DC",
        "name": "Для женщин",
        "title": "Для женщин",
        "url": "/Dlya-zhenshchin",
        "features": [
          {
            "id": "f1000116DC",
            "name": "Сезон",
            "values": [
              "",
              "Осень - зима",
              "Лето"
            ],
            "createdDate": "2024-02-13T13:56:56.82"
          },
          {
            "id": "f1000117DC",
            "name": "Вид застежки",
            "values": [
              "",
              "На молнии",
              "пуговка"
            ],
            "createdDate": "2024-02-13T13:57:50.053"
          },
          {
            "id": "f1000093DC",
            "name": "Бренд",
            "values": [
              "",
              "FarmStay"
            ],
            "createdDate": "2024-01-17T11:10:02.337"
          }
        ],
        "type": "WITH_PRODUCTS",
        "parentCategoryId": "cat1000224DC",
        "level": 2,
        "order": 37,
        "seo": {
          "title": "Глобальный Шаблон 2 title %name-category%",
          "keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
          "description": "Глобальный шаблон description %name-product% в %name-category%  от %price-min% до %price-max%"
        },
        "catalogId": "master-catalog"
      },
      "status": 300,
      "catalogId": "master-catalog",
      "variants": [
        {
          "id": "1001683DC",
          "productId": "1001682DC",
          "name": "Шорты женские",
          "description": "",
          "assets": [
            {
              "id": "650992ee52313c36d21a9e35",
              "media": {
                "url": "master/catalog/images/1695126242399-1882559365.JPG",
                "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1695126242399-1882559365.JPG",
                "name": "Шорты женские.JPG",
                "type": "PHOTO",
                "size": 50183,
                "resolution": "795x810 px",
                "createdDate": "2023-09-19T15:24:14.387"
              },
              "title": "Шорты женские",
              "altAttr": "шорты",
              "description": "",
              "sign": "",
              "tags": [
                ""
              ]
            }
          ],
          "attributes": [
            {
              "featureId": "f1000116DC",
              "name": "Сезон",
              "indexable": true,
              "value": "Лето"
            }
          ],
          "status": 300,
          "orderable": false
        }
      ]
    },
    {
      "id": "1009006DC",
      "name": "Шорты светлые",
      "seo": {
        "title": "%name-product% ",
        "keywords": "глобальный шаблон keywords %name-product% ",
        "description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"
      },
      "description": "Отличные шорты для весенне-летней погоды. Выполнены из натурального хлопка очень легкие и невесомые! Отличный вариант для летнего отдыха.",
      "assets": [
        {
          "id": "da1a24b8-32af-4a66-bbdc-188127cebb41",
          "media": {
            "url": "master/catalog/images/1713437908714-1882559365.jpg",
            "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908714-1882559365.jpg",
            "name": "photo_2024-01-10_19-20-00.jpg",
            "type": "PHOTO",
            "size": 134254,
            "resolution": "900x1200 px",
            "createdDate": "2024-04-18T13:58:30.589"
          },
          "title": "photo_2024-01-10_19-20-00",
          "altAttr": "photo_2024-01-10_19-20-00",
          "description": "",
          "sign": "",
          "tags": [
            ""
          ]
        },
        {
          "id": "a34cf313-3058-48ff-9109-faa07416e74c",
          "media": {
            "url": "master/catalog/images/1713437908760-1882559365.jpg",
            "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908760-1882559365.jpg",
            "name": "photo_2024-01-10_19-26-00.jpg",
            "type": "PHOTO",
            "size": 228232,
            "resolution": "900x1200 px",
            "createdDate": "2024-04-18T13:58:30.587"
          },
          "title": "photo_2024-01-10_19-26-00",
          "altAttr": "photo_2024-01-10_19-26-00",
          "description": "",
          "sign": "",
          "tags": [
            ""
          ]
        },
        {
          "id": "66ddb53c-441d-4061-9da8-6aa701aa977e",
          "media": {
            "url": "master/catalog/images/1713437908626-1882559365.jpg",
            "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908626-1882559365.jpg",
            "name": "photo_2024-01-10_19-17-48.jpg",
            "type": "PHOTO",
            "size": 105995,
            "resolution": "900x1200 px",
            "createdDate": "2024-04-18T13:58:30.586"
          },
          "title": "photo_2024-01-10_19-17-48",
          "altAttr": "photo_2024-01-10_19-17-48",
          "description": "",
          "sign": "",
          "tags": [
            ""
          ]
        },
        {
          "id": "a070203e-2420-4944-ba49-fea4423b26dd",
          "media": {
            "url": "master/catalog/images/1713437908807-1882559365.jpg",
            "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908807-1882559365.jpg",
            "name": "photo_2024-01-10_19-26-11.jpg",
            "type": "PHOTO",
            "size": 207702,
            "resolution": "900x1200 px",
            "createdDate": "2024-04-18T13:58:30.585"
          },
          "title": "photo_2024-01-10_19-26-11",
          "altAttr": "photo_2024-01-10_19-26-11",
          "description": "",
          "sign": "",
          "tags": [
            ""
          ]
        }
      ],
      "features": [],
      "category": {
        "id": "cat1000225DC",
        "name": "Для женщин",
        "title": "Для женщин",
        "url": "/Dlya-zhenshchin",
        "features": [
          {
            "id": "f1000116DC",
            "name": "Сезон",
            "values": [
              "",
              "Осень - зима",
              "Лето"
            ],
            "createdDate": "2024-02-13T13:56:56.82"
          },
          {
            "id": "f1000117DC",
            "name": "Вид застежки",
            "values": [
              "",
              "На молнии",
              "пуговка"
            ],
            "createdDate": "2024-02-13T13:57:50.053"
          },
          {
            "id": "f1000093DC",
            "name": "Бренд",
            "values": [
              "",
              "FarmStay"
            ],
            "createdDate": "2024-01-17T11:10:02.337"
          }
        ],
        "type": "WITH_PRODUCTS",
        "parentCategoryId": "cat1000224DC",
        "level": 2,
        "order": 37,
        "seo": {
          "title": "Глобальный Шаблон 2 title %name-category%",
          "keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
          "description": "Глобальный шаблон description %name-product% в %name-category%  от %price-min% до %price-max%"
        },
        "catalogId": "master-catalog"
      },
      "status": 300,
      "catalogId": "master-catalog",
      "variants": [
        {
          "id": "1009007DC",
          "productId": "1009006DC",
          "name": "123",
          "description": "Отличные шорты для весенне-летней погоды. Выполнены из натурального хлопка очень легкие и невесомые!",
          "assets": [
            {
              "id": "da1a24b8-32af-4a66-bbdc-188127cebb41",
              "media": {
                "url": "master/catalog/images/1713437908714-1882559365.jpg",
                "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908714-1882559365.jpg",
                "name": "photo_2024-01-10_19-20-00.jpg",
                "type": "PHOTO",
                "size": 134254,
                "resolution": "900x1200 px",
                "createdDate": "2024-04-18T13:58:30.589"
              },
              "title": "photo_2024-01-10_19-20-00",
              "altAttr": "photo_2024-01-10_19-20-00",
              "description": "",
              "sign": "",
              "tags": [
                ""
              ]
            },
            {
              "id": "a34cf313-3058-48ff-9109-faa07416e74c",
              "media": {
                "url": "master/catalog/images/1713437908760-1882559365.jpg",
                "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908760-1882559365.jpg",
                "name": "photo_2024-01-10_19-26-00.jpg",
                "type": "PHOTO",
                "size": 228232,
                "resolution": "900x1200 px",
                "createdDate": "2024-04-18T13:58:30.587"
              },
              "title": "photo_2024-01-10_19-26-00",
              "altAttr": "photo_2024-01-10_19-26-00",
              "description": "",
              "sign": "",
              "tags": [
                ""
              ]
            },
            {
              "id": "66ddb53c-441d-4061-9da8-6aa701aa977e",
              "media": {
                "url": "master/catalog/images/1713437908626-1882559365.jpg",
                "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908626-1882559365.jpg",
                "name": "photo_2024-01-10_19-17-48.jpg",
                "type": "PHOTO",
                "size": 105995,
                "resolution": "900x1200 px",
                "createdDate": "2024-04-18T13:58:30.586"
              },
              "title": "photo_2024-01-10_19-17-48",
              "altAttr": "photo_2024-01-10_19-17-48",
              "description": "",
              "sign": "",
              "tags": [
                ""
              ]
            },
            {
              "id": "a070203e-2420-4944-ba49-fea4423b26dd",
              "media": {
                "url": "master/catalog/images/1713437908807-1882559365.jpg",
                "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908807-1882559365.jpg",
                "name": "photo_2024-01-10_19-26-11.jpg",
                "type": "PHOTO",
                "size": 207702,
                "resolution": "900x1200 px",
                "createdDate": "2024-04-18T13:58:30.585"
              },
              "title": "photo_2024-01-10_19-26-11",
              "altAttr": "photo_2024-01-10_19-26-11",
              "description": "",
              "sign": "",
              "tags": [
                ""
              ]
            }
          ],
          "attributes": [
            {
              "featureId": "f1000016DC",
              "name": "Состав",
              "indexable": true,
              "value": "95% хлопок, 5% эластан"
            }
          ],
          "status": 400,
          "orderable": false
        },
        {
          "id": "1009008DC",
          "barcode": "",
          "nomenclature": "",
          "productId": "1009006DC",
          "name": "Шорты светлые",
          "description": "Отличные шорты для весенне-летней погоды. Выполнены из натурального хлопка очень легкие и невесомые! Отличный вариант для летнего отдыха.",
          "assets": [
            {
              "id": "da1a24b8-32af-4a66-bbdc-188127cebb41",
              "media": {
                "url": "master/catalog/images/1713437908714-1882559365.jpg",
                "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908714-1882559365.jpg",
                "name": "photo_2024-01-10_19-20-00.jpg",
                "type": "PHOTO",
                "size": 134254,
                "resolution": "900x1200 px",
                "createdDate": "2024-04-18T13:58:30.589"
              },
              "title": "photo_2024-01-10_19-20-00",
              "altAttr": "photo_2024-01-10_19-20-00",
              "description": "",
              "sign": "",
              "tags": [
                ""
              ]
            },
            {
              "id": "a34cf313-3058-48ff-9109-faa07416e74c",
              "media": {
                "url": "master/catalog/images/1713437908760-1882559365.jpg",
                "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908760-1882559365.jpg",
                "name": "photo_2024-01-10_19-26-00.jpg",
                "type": "PHOTO",
                "size": 228232,
                "resolution": "900x1200 px",
                "createdDate": "2024-04-18T13:58:30.587"
              },
              "title": "photo_2024-01-10_19-26-00",
              "altAttr": "photo_2024-01-10_19-26-00",
              "description": "",
              "sign": "",
              "tags": [
                ""
              ]
            },
            {
              "id": "66ddb53c-441d-4061-9da8-6aa701aa977e",
              "media": {
                "url": "master/catalog/images/1713437908626-1882559365.jpg",
                "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908626-1882559365.jpg",
                "name": "photo_2024-01-10_19-17-48.jpg",
                "type": "PHOTO",
                "size": 105995,
                "resolution": "900x1200 px",
                "createdDate": "2024-04-18T13:58:30.586"
              },
              "title": "photo_2024-01-10_19-17-48",
              "altAttr": "photo_2024-01-10_19-17-48",
              "description": "",
              "sign": "",
              "tags": [
                ""
              ]
            },
            {
              "id": "a070203e-2420-4944-ba49-fea4423b26dd",
              "media": {
                "url": "master/catalog/images/1713437908807-1882559365.jpg",
                "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908807-1882559365.jpg",
                "name": "photo_2024-01-10_19-26-11.jpg",
                "type": "PHOTO",
                "size": 207702,
                "resolution": "900x1200 px",
                "createdDate": "2024-04-18T13:58:30.585"
              },
              "title": "photo_2024-01-10_19-26-11",
              "altAttr": "photo_2024-01-10_19-26-11",
              "description": "",
              "sign": "",
              "tags": [
                ""
              ]
            }
          ],
          "attributes": [
            {
              "featureId": "f1000016DC",
              "name": "Состав",
              "indexable": true,
              "value": "80% хлопок, 20% полиэстер"
            }
          ],
          "status": 300,
          "orderable": false
        }
      ]
    }
  ],
  "number": 0,
  "size": 2,
  "totalElements": 4,
  "pageable": "INSTANCE",
  "last": false,
  "totalPages": 2,
  "sort": {
    "unsorted": true,
    "sorted": false,
    "empty": true
  },
  "first": true,
  "numberOfElements": 2,
  "empty": false
}
Copy-icon
Response codes

200 - операция успешно выполнена, получена страница с товарами

  • Получение списка товаров - POST запрос, /v1/products/list
Request parameters

extended - query-параметр: флаг, который указывает, нужно ли возвращать товары вместе с ценами и остатками
Copy-icon
Request body sample

{
  "articleId": "1019689DC",
  "catalogId": "c1000001DC"
}
Copy-icon
Response sample

[
  {
    "id": "1019689DC",
    "externalId": "22222",
    "name": "Куртка женская",
    "seo": {
      "title": "%name-product% ",
      "keywords": "глобальный шаблон keywords %name-product% ",
      "description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"
    },
    "description": "Куртка на зиму.",
    "assets": [
      {
        "id": "0e8ffc05-a085-4c5a-9679-de91d9b1367b",
        "media": {
          "url": "master/catalog/images/1715161957085-1882559365.png",
          "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1715161957085-1882559365.png",
          "name": "Jacket.svg.png",
          "type": "PHOTO",
          "size": 5004,
          "resolution": "640x320 px",
          "createdDate": "2024-05-08T12:52:38.062"
        },
        "title": "female_jacket",
        "altAttr": "female_jacket",
        "description": "",
        "sign": "",
        "tags": [
          ""
        ]
      }
    ],
    "features": [],
    "category": {
      "id": "cat1007760DC",
      "name": "Одежда",
      "title": "Одежда",
      "url": "/Odezhda",
      "media": {
        "id": "0e8ffc05-a085-4c5a-9679-de91d9b1367b",
        "media": {
          "url": "master/catalog/images/1715161957085-1882559365.png",
          "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1715161957085-1882559365.png",
          "name": "Jacket.png",
          "type": "PHOTO",
          "size": 5004,
          "resolution": "640x320 px",
          "createdDate": "2024-05-08T12:52:38.062"
        },
        "title": "female_jacket",
        "altAttr": "female_jacket",
        "description": "",
        "sign": "",
        "tags": [
          ""
        ]
      },
      "features": [],
      "type": "WITH_PRODUCTS",
      "parentCategoryId": "",
      "level": 1,
      "order": 82,
      "seo": {
        "title": "Глобальный Шаблон 2 title %name-category%",
        "keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
        "description": "Глобальный шаблон description %name-product% в %name-category%  от %price-min% до %price-max%"
      },
      "catalogId": "c1000001DC"
    },
    "status": 100,
    "catalogId": "c1000001DC",
    "variants": [
      {
        "id": "1019690DC",
        "productId": "1019689DC",
        "name": "Куртка женская",
        "description": "",
        "assets": [],
        "attributes": [],
        "status": 100,
        "orderable": false
      }
    ]
  }
]
Copy-icon
Response codes

200 - операция успешно выполнена, получен список с товарами

  • Получение продукта по его ID - GET запрос, /v2/products/{id}
Request parameters

id - path-параметр, обязательный: уникальный идентификатор продукта
extended - query-параметр: флаг, который указывает, нужно ли возвращать товары вместе с ценами и остатками
currencyId - query-параметр: ID валюты, в которой нужно вернуть цены на товар
available - query-параметр: флаг наличия товара на складе
Copy-icon
Response sample

{
    "id": "1019689DC",
    "externalId": "22222",
    "name": "Куртка женская",
    "seo": {
      "title": "%name-product% ",
      "keywords": "глобальный шаблон keywords %name-product% ",
      "description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"
    },
    "description": "Куртка на зиму.",
    "assets": [
      {
        "id": "0e8ffc05-a085-4c5a-9679-de91d9b1367b",
        "media": {
          "url": "master/catalog/images/1715161957085-1882559365.png",
          "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1715161957085-1882559365.png",
          "name": "Jacket.svg.png",
          "type": "PHOTO",
          "size": 5004,
          "resolution": "640x320 px",
          "createdDate": "2024-05-08T12:52:38.062"
        },
        "title": "female_jacket",
        "altAttr": "female_jacket",
        "description": "",
        "sign": "",
        "tags": [
          ""
        ]
      }
    ],
    "features": [],
    "category": {
      "id": "cat1007760DC",
      "name": "Одежда",
      "title": "Одежда",
      "url": "/Odezhda",
      "media": {
        "id": "0e8ffc05-a085-4c5a-9679-de91d9b1367b",
        "media": {
          "url": "master/catalog/images/1715161957085-1882559365.png",
          "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1715161957085-1882559365.png",
          "name": "Jacket.png",
          "type": "PHOTO",
          "size": 5004,
          "resolution": "640x320 px",
          "createdDate": "2024-05-08T12:52:38.062"
        },
        "title": "female_jacket",
        "altAttr": "female_jacket",
        "description": "",
        "sign": "",
        "tags": [
          ""
        ]
      },
      "features": [],
      "type": "WITH_PRODUCTS",
      "parentCategoryId": "",
      "level": 1,
      "order": 82,
      "seo": {
        "title": "Глобальный Шаблон 2 title %name-category%",
        "keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
        "description": "Глобальный шаблон description %name-product% в %name-category%  от %price-min% до %price-max%"
      },
      "catalogId": "c1000001DC"
    },
    "status": 100,
    "catalogId": "c1000001DC",
    "variants": [
      {
        "id": "1019690DC",
        "productId": "1019689DC",
        "name": "Куртка женская",
        "description": "",
        "assets": [],
        "attributes": [],
        "status": 100,
        "orderable": false
      }
    ]
  }
Copy-icon
Response codes
  • 200 - операция выполнена успешно, получены данные товара
  • 404 - ошибка, товар с таким ID не найден
  • Создание товара - POST запрос, /v2/products
Request body sample

{
    "name": "Спортивная футболка",
    "description": "Классная футболка для спорта.",
    "assets": [
        {
            "id": "bda4c2a4-6683-43e6-bc53-feb8e1bf0989"
        }
    ],
    "category": {
        "id": "cat1000224DC"
    },
    "status": 100,
    "variants": [
        {
            "mediaAssetIds": [
                "bda4c2a4-6683-43e6-bc53-feb8e1bf0989"
            ],
            "attributes": [],
            "status": 100
        }
    ],
    "features": [
        {
            "featureId": "f1000005DC",
            "name": "Страна производства",
            "indexable": true,
            "value": ""
        }
    ],
    "seo": {
        "title": "",
        "keywords": "",
        "description": ""
    }
}
Copy-icon
Response sample

Отсутствует.

Response codes

201 - операция выполнена успешно, товар создан

  • Редактирование отфильтрованных товаров - PATCH запрос, /v2/products
Request body sample

{
  "filter": {//критерии, по которым отфильтровываются товары для редактирования
  },
  "body": {//изменения, для внесения в отфильтрованные товары
      }
}
Copy-icon
Response sample

Отсутствует.

Response codes

202 - операция успешно выполнена, товары обновлены

  • Редактирование товара - PATCH запрос, /v2/products/{id}
Request parameters

id - path-параметр, обязательный: уникальный идентификатор товара
Copy-icon
Request body sample

{
    "id": "1019682DC",
    "name": "Спортивная футболка",
    "seo": {
        "title": "%name-product% ",
        "keywords": "глобальный шаблон keywords %name-product% ",
        "description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"
    },
    "description": "Классная футболка для занятий спортом для женщин.",
    "assets": [
        {
            "id": "bda4c2a4-6683-43e6-bc53-feb8e1bf0989",
            "media": {
                "url": "master/catalog/images/1706533175315-1882559365.jpg",
                "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1706533175315-1882559365.jpg",
                "name": "photo_2024-01-10_23-35-20.jpg",
                "type": "PHOTO",
                "size": 132516,
                "resolution": "900x1200 px",
                "createdDate": "2024-01-29T15:59:43.168"
            },
            "title": "photo_2024-01-10_23-35-20",
            "altAttr": "photo_2024-01-10_23-35-20",
            "description": "",
            "sign": "",
            "tags": [
                ""
            ]
        }
    ],
    "features": [
        {
            "featureId": "f1000005DC",
            "name": "Страна производства",
            "indexable": true,
            "value": ""
        }
    ],
    "category": {
        "id": "cat1000224DC",
        "name": "Одежда универсальная",
        "title": "Одежда универсальная",
        "url": "/Odezhda-universalnaya",
        "media": {
            "id": "02e62a7a-9c76-4cb2-9156-19ee57047ced",
            "media": {
                "url": "master/catalog/images/1713788986747-1882559365.png",
                "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713788986747-1882559365.png",
                "name": "костюм 2.png",
                "type": "PHOTO",
                "size": 1013408,
                "resolution": "900x1200 px",
                "createdDate": "2024-04-22T15:29:48.78"
            },
            "title": "костюм 2",
            "altAttr": "костюм 2",
            "description": "",
            "sign": "",
            "tags": [
                ""
            ]
        },
        "features": [
            {
                "id": "f1000005DC",
                "name": "Страна производства",
                "values": [
                    "",
                    "Россия",
                    "Малайзия",
                    "Узбекистан",
                    "Канада",
                    "Беларусь",
                    "Китай",
                    "Турция",
                    "Индия",
                    "Япония",
                    "Бразилия"
                ],
                "createdDate": "2023-11-30T14:25:26.884"
            }
        ],
        "type": "WITH_PRODUCTS",
        "level": 1,
        "order": 76,
        "seo": {
            "title": "Глобальный Шаблон 2 title %name-category%",
            "keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
            "description": "Глобальный шаблон description %name-product% в %name-category%  от %price-min% до %price-max%"
        },
        "catalogId": "master-catalog"
    },
    "status": 100,
    "catalogId": "master-catalog",
    "variants": [
        {
            "id": "1019683DC",
            "productId": "1019682DC",
            "name": "Спортивная футболка",
            "description": "Классная футболка для спорта.",
            "assets": [],
            "attributes": [],
            "status": 100,
            "orderable": false
        }
    ]
}
Copy-icon
Response sample

Отсутствует.

Response codes

202 - операция выполнена успешно, товар обновлен

  • Получение статуса товара по его ID - GET запрос, /v1/products/{id}/status
Request parameters

id - path-параметр, обязательный: уникальный идентификатор товара, чей статус нужно получить
Copy-icon
Response sample 
{
  "status": 300
}
Copy-icon
Response codes
  • 200 - операция выполнена успешно, получен статус товара
  • 404 - ошибка, товар с таким ID не найден
  • Получение списка общих атрибутов товаров (при пакетном (массовом) изменении)  - POST запрос, /v1/products/common-values
Request parameters

Отсутствуют.

Request body sample

{
    "articleIds": [
        "1069061DC",
        "1069855DC"
    ],
    "catalogId": "c1000001DC"
}
Copy-icon
Response sample

{
    "externalId": "",
    "seo": {
        "title": "%name-product%",
        "keywords": "глобальный шаблон keywords %name-product%",
        "description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"
    },
    "description": "",
    "catalogId": "c1000001DC"
}
Copy-icon
Response codes

200 - операция выполнена успешно, получен список общих атрибутов товаров

  • Получение товара по его ID - GET запрос, /v3/products/{id}
Request parameters

id - path-параметр, обязательный: уникальный идентификатор товара
extended - query-параметр: флаг, который указывает, нужно ли возвращать товары вместе с ценами и остатками
currencyId - query-параметр: ID валюты, в которой нужно вернуть цены на товар
Copy-icon
Response sample

{
    "id": "1019689DC",
    "externalId": "22222",
    "name": "Куртка женская",
    "seo": {
      "title": "%name-product% ",
      "keywords": "глобальный шаблон keywords %name-product% ",
      "description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"
    },
    "description": "Куртка на зиму.",
    "assets": [
      {
        "id": "0e8ffc05-a085-4c5a-9679-de91d9b1367b",
        "media": {
          "url": "master/catalog/images/1715161957085-1882559365.png",
          "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1715161957085-1882559365.png",
          "name": "Jacket.svg.png",
          "type": "PHOTO",
          "size": 5004,
          "resolution": "640x320 px",
          "createdDate": "2024-05-08T12:52:38.062"
        },
        "title": "female_jacket",
        "altAttr": "female_jacket",
        "description": "",
        "sign": "",
        "tags": [
          ""
        ]
      }
    ],
    "features": [],
    "category": {
      "id": "cat1007760DC",
      "name": "Одежда",
      "title": "Одежда",
      "url": "/Odezhda",
      "media": {
        "id": "0e8ffc05-a085-4c5a-9679-de91d9b1367b",
        "media": {
          "url": "master/catalog/images/1715161957085-1882559365.png",
          "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1715161957085-1882559365.png",
          "name": "Jacket.png",
          "type": "PHOTO",
          "size": 5004,
          "resolution": "640x320 px",
          "createdDate": "2024-05-08T12:52:38.062"
        },
        "title": "female_jacket",
        "altAttr": "female_jacket",
        "description": "",
        "sign": "",
        "tags": [
          ""
        ]
      },
      "features": [],
      "type": "WITH_PRODUCTS",
      "parentCategoryId": "",
      "level": 1,
      "order": 82,
      "seo": {
        "title": "Глобальный Шаблон 2 title %name-category%",
        "keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
        "description": "Глобальный шаблон description %name-product% в %name-category%  от %price-min% до %price-max%"
      },
      "catalogId": "c1000001DC"
    },
    "status": 100,
    "catalogId": "c1000001DC",
    "variants": [
      {
        "id": "1019690DC",
        "productId": "1019689DC",
        "name": "Куртка женская",
        "description": "",
        "assets": [],
        "attributes": [],
        "status": 100,
        "orderable": false
      }
    ]
  }
Copy-icon
Response codes
  • 200 - операция выполнена успешно, получены данные товара
  • 404 - ошибка, товар не найден
  • Создание товара (с кэшированием) - POST запрос, /v3/products
Request parameters

Отсутствуют.

Request body sample

{
    "name": "Брюки",
    "description": "Качественный брюки для мужчин.",
    "assets": [],
    "category": {
        "id": "cat1007839DC"
    },
    "status": 100,
    "externalId": "",
    "variants": [
        {
            "assets": [],
            "attributes": [],
            "status": 100,
            "externalId": ""
        }
    ],
    "catalogId": "c1000001DC",
    "features": [
        {
            "featureId": "f1000009DC",
            "name": "Глубина",
            "indexable": true,
            "value": ""
        },
        {
            "featureId": "f1000055DC",
            "name": "Характеристика",
            "indexable": true,
            "value": ""
        },
        {
            "featureId": "f1000080DC",
            "name": "Упаковка",
            "indexable": true,
            "value": ""
        }
    ],
    "seo": {
        "title": "",
        "keywords": "",
        "description": ""
    }
}
Copy-icon
Response sample

Отсутствует.

Response codes

201 - операция выполнена успешно, товар создан

  • Редактирование товара (с кэшированием) - PATCH запрос, /v3/products/{id}
Request parameters

id - path-параметр, обязательный: уникальный идентификатор товара
Copy-icon
Request body sample

{

    "name": "Брюки",

    "externalId": "",

    "description": "Качественный брюки для мужчин!",

    "assets": [],

    "category": {

        "id": "cat1007839DC"

    },

    "status": 100,

    "variants": [

        {

            "id": "1074323DC",

            "productId": "1074322DC",

            "attributes": [],

            "status": 100,

            "assets": [],

            "name": "Брюки",

            "externalId": "",

            "description": "Качественный брюки для мужчин."

        }

    ],

    "catalogId": "c1000001DC",

    "features": [

        {

            "featureId": "f1000009DC",

            "name": "Глубина",

            "indexable": true,

            "value": ""

        },

        {

            "featureId": "f1000055DC",

            "name": "Характеристика",

            "indexable": true,

            "value": ""

        },

        {

            "featureId": "f1000080DC",

            "name": "Упаковка",

            "indexable": true,

            "value": ""

        }

    ],

    "seo": {

        "title": "%name-category%",

        "keywords": "глобальный шаблон keywords %name-product% ",

        "description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"

    }

}
Copy-icon
Response sample

Отсутствует.

Response codes
  • 202 - операция выполнена успешно, товар обновлена
  • 204 - No Content
  • Получение товара по его ID (с кэшированием) - GET запрос, /v5/products/{id}
Request parameters

id - path-параметр, обязательный: уникальный идентификатор товара
Copy-icon
Response sample 

{
  "id": "1074320DC",
  "externalId": "",
  "name": "Блузка шелковая",
  "seo": {
    "title": "%name-category%",
    "keywords": "глобальный шаблон keywords %name-product% ",
    "description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"
  },
  "description": "",
  "assets": [
    {
      "id": "88ecfdd7-aa81-41ef-bb4d-83528bb81029",
      "media": {
        "url": "master/catalog/images/1722346704400-1882559365.jpg",
        "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1722346704400-1882559365.jpg",
        "name": "1690994436197-1882559365.jpg",
        "type": "PHOTO",
        "size": 7434,
        "resolution": "219x230 px",
        "createdDate": "2024-07-30T16:38:25.306"
      },
      "title": "1690994436197-1882559365",
      "altAttr": "1690994436197-1882559365",
      "description": "",
      "sign": "",
      "tags": [
        ""
      ]
    }
  ],
  "features": [
    {
      "featureId": "f1000005DC",
      "name": "Страна производства",
      "indexable": true,
      "value": ""
    }
  ],
  "category": {
    "id": "cat1007760DC",
    "name": "Категория РБ",
    "title": "Категория РБ",
    "url": "/Kategoriya-RB",
    "media": {
      "id": "0e8ffc05-a085-4c5a-9679-de91d9b1367b",
      "media": {
        "url": "master/catalog/images/1715161957085-1882559365.png",
        "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1715161957085-1882559365.png",
        "name": "Flag_of_Belarus.svg.png",
        "type": "PHOTO",
        "size": 5004,
        "resolution": "640x320 px",
        "createdDate": "2024-05-08T12:52:38.062"
      },
      "title": "Flag_of_Belarus",
      "altAttr": "Flag_of_Belarus",
      "description": "",
      "sign": "",
      "tags": [
        ""
      ]
    },
    "features": [
      {
        "id": "f1000005DC",
        "name": "Страна производства",
        "values": [
          "",
          "Россия",
          "Малайзия",
          "Узбекистан",
          "Канада",
          "Беларусь",
          "Китай",
          "Турция",
          "Индия",
          "Япония",
          "Бразилия"
        ],
        "createdDate": "2024-07-31T15:24:10.793"
      }
    ],
    "type": "WITH_PRODUCTS",
    "parentCategoryId": "",
    "level": 1,
    "order": 82,
    "seo": {
      "title": "Глобальный Шаблон 2 title %name-category%",
      "keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
      "description": "Глобальный шаблон description %name-product% в %name-category%  от %price-min% до %price-max%"
    },
    "catalogId": "c1000001DC"
  },
  "status": 300,
  "catalogId": "c1000001DC",
  "variants": [
    {
      "id": "1074321DC",
      "externalId": "",
      "productId": "1074320DC",
      "name": "Блузка шелковая",
      "description": "",
      "assets": [
        {
          "id": "88ecfdd7-aa81-41ef-bb4d-83528bb81029",
          "media": {
            "url": "master/catalog/images/1722346704400-1882559365.jpg",
            "absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1722346704400-1882559365.jpg",
            "name": "1690994436197-1882559365.jpg",
            "type": "PHOTO",
            "size": 7434,
            "resolution": "219x230 px",
            "createdDate": "2024-07-30T16:38:25.306"
          },
          "title": "1690994436197-1882559365",
          "altAttr": "1690994436197-1882559365",
          "description": "",
          "sign": "",
          "tags": [
            ""
          ]
        }
      ],
      "attributes": [],
      "status": 300,
      "availability": {
        "articleId": "1074321DC",
        "quantity": 100,
        "replenishmentTime": 0
      },
      "prices": {
        "02d3eb94-8d0c-4e21-a952-db8684a1534d": {
          "unitPrice": 1000,
          "discountUnitPrice": 1000
        }
      },
      "orderable": true
    }
  ]
}
Copy-icon
Response codes

200 - операция выполнена успешно, получены данные товара

  • Отправка списка товаров на загрузку с помощью REST - PUT запрос, /v1/products/list
Request parameters

Отсутствуют.

Request body sample

{
  "products": [
    {
    "id": "1074042DC",
      "name": "Iphone",
      "externalId": "",
      "description": "",
      "assets": [
        {
          "id": "15bee320-d89b-45c8-9a6b-298e9997bb97"
        }
      ],
      "category": {
        "id": "cat1007839DC"
      },
      "status": 200,
      "variants": [
        {
          "id": "1074047DC",
          "productId": "1074042DC",
          "attributes": [],
          "status": 200,
          "assets": [
            {
              "id": "d791baa2-d32b-4d7d-a5e9-94c4ad1e83e6"
            }
          ],
          "name": "iPhone",
          "externalId": "",
          "description": ""
        }
      ],
      "catalogId": "c1000001DC",
      "features": [
        {
          "featureId": "f1000009DC",
          "name": "Глубина",
          "indexable": true,
          "value": ""
        },
        {
          "featureId": "f1000055DC",
          "name": "Характеристика",
          "indexable": true,
          "value": ""
        },
        {
          "featureId": "f1000080DC",
          "name": "Упаковка",
          "indexable": true,
          "value": ""
        }
      ],
      "seo": {
        "title": "%name-product%",
        "keywords": "глобальный шаблон keywords %name-product% ",
        "description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"
      }
    },
    {
    "id": "",
      "name": "Samsung",
      "externalId": "",
      "description": "",
      "assets": [
        {
          "id": "3db3d9a9-1f02-40c6-9c41-2af452cf099f"
        }
      ],
      "category": {
        "id": "cat1007839DC"
      },
      "status": 200,
      "variants": [
        {
          "id": "",
          "productId": "",
          "attributes": [],
          "status": 200,
          "assets": [
            {
              "id": "3db3d9a9-1f02-40c6-9c41-2af452cf099f"
            }
          ],
          "name": "Samsung",
          "externalId": "",
          "description": ""
        }
      ],
      "catalogId": "c1000001DC",
      "features": [
        {
          "featureId": "f1000009DC",
          "name": "Глубина",
          "indexable": true,
          "value": ""
        },
        {
          "featureId": "f1000055DC",
          "name": "Характеристика",
          "indexable": true,
          "value": ""
        },
        {
          "featureId": "f1000080DC",
          "name": "Упаковка",
          "indexable": true,
          "value": ""
        }
      ],
      "seo": {
        "title": "%name-product%",
        "keywords": "глобальный шаблон keywords %name-product% ",
        "description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"
      }
    }
  ]
}
Copy-icon
Response sample 

{
  "created": 1,
  "updated": 1
}
Copy-icon
Response codes

200 - операция выполнена успешно

  • Отправка списка товаров на загрузку с помощью вызова grpc - PUT запрос, /v2/products/list
Request parameters

Отсутствуют.

Request body sample

{

  "products": [

    {

    "id": "1074042DC",

      "name": "iPhone",

      "external_id": "",

      "description": "",

      "assets": [

        {

          "id": "15bee320-d89b-45c8-9a6b-298e9997bb97"

        }

      ],

      "category": {

        "id": "cat1007839DC"

      },

      "status": 200,

      "variants": [

        {

          "id": "1074047DC",

          "product_id": "1074042DC",

          "attributes": [],

          "status": 200,

          "assets": [

            {

              "id": "d791baa2-d32b-4d7d-a5e9-94c4ad1e83e6"

            }

          ],

          "name": "iPhone",

          "externalId": "",

          "description": ""

        }

      ],

      "catalog_id": "c1000001DC",

      "features": [

        {

          "feature_id": "f1000009DC",

          "name": "Глубина",

          "indexable": true,

          "value": ""

        },

        {

          "feature_id": "f1000055DC",

          "name": "Характеристика",

          "indexable": true,

          "value": ""

        },

        {

          "feature_id": "f1000080DC",

          "name": "Упаковка",

          "indexable": true,

          "value": ""

        }

      ],

      "seo": {

        "title": "%name-product%",

        "keywords": "глобальный шаблон keywords %name-product% ",

        "description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"

      }

    },

    {

    "id": "",

      "name": "Samsung",

      "external_id": "",

      "description": "",

      "assets": [

        {

          "id": "3db3d9a9-1f02-40c6-9c41-2af452cf099f"

        }

      ],

      "category": {

        "id": "cat1007839DC"

      },

      "status": 200,

      "variants": [

        {

          "id": "",

          "product_id": "",

          "attributes": [],

          "status": 200,

          "assets": [

            {

              "id": "3db3d9a9-1f02-40c6-9c41-2af452cf099f"

            }

          ],

          "name": "Samsung",

          "externalId": "",

          "description": ""

        }

      ],

      "catalog_id": "c1000001DC",

      "features": [

        {

          "feature_id": "f1000009DC",

          "name": "Глубина",

          "indexable": true,

          "value": ""

        },

        {

          "feature_id": "f1000055DC",

          "name": "Характеристика",

          "indexable": true,

          "value": ""

        },

        {

          "feature_id": "f1000080DC",

          "name": "Упаковка",

          "indexable": true,

          "value": ""

        }

      ],

      "seo": {

        "title": "%name-product%",

        "keywords": "глобальный шаблон keywords %name-product% ",

        "description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"

      }

    }

  ]

}
Copy-icon
Response sample

{
  "created": 1,
  "updated": 1
}
Copy-icon
Response codes

200 - операция выполнена успешно

  • Отправка списка товаров на загрузку с помощью стрима grpc - PUT запрос, /v3/products/list
Request parameters

Отсутствуют.

Request body sample

{

  "products": [

    {

    "id": "1074042DC",

      "name": "iPhone",

      "external_id": "",

      "description": "",

      "assets": [

        {

          "id": "15bee320-d89b-45c8-9a6b-298e9997bb97"

        }

      ],

      "category": {

        "id": "cat1007839DC"

      },

      "status": 200,

      "variants": [

        {

          "id": "1074047DC",

          "product_id": "1074042DC",

          "attributes": [],

          "status": 200,

          "assets": [

            {

              "id": "d791baa2-d32b-4d7d-a5e9-94c4ad1e83e6"

            }

          ],

          "name": "iPhone",

          "externalId": "",

          "description": ""

        }

      ],

      "catalog_id": "c1000001DC",

      "features": [

        {

          "feature_id": "f1000009DC",

          "name": "Глубина",

          "indexable": true,

          "value": ""

        },

        {

          "feature_id": "f1000055DC",

          "name": "Характеристика",

          "indexable": true,

          "value": ""

        },

        {

          "feature_id": "f1000080DC",

          "name": "Упаковка",

          "indexable": true,

          "value": ""

        }

      ],

      "seo": {

        "title": "%name-product%",

        "keywords": "глобальный шаблон keywords %name-product% ",

        "description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"

      }

    },

    {

    "id": "",

      "name": "Samsung",

      "external_id": "",

      "description": "",

      "assets": [

        {

          "id": "3db3d9a9-1f02-40c6-9c41-2af452cf099f"

        }

      ],

      "category": {

        "id": "cat1007839DC"

      },

      "status": 200,

      "variants": [

        {

          "id": "",

          "product_id": "",

          "attributes": [],

          "status": 200,

          "assets": [

            {

              "id": "3db3d9a9-1f02-40c6-9c41-2af452cf099f"

            }

          ],

          "name": "Samsung",

          "externalId": "",

          "description": ""

        }

      ],

      "catalog_id": "c1000001DC",

      "features": [

        {

          "feature_id": "f1000009DC",

          "name": "Глубина",

          "indexable": true,

          "value": ""

        },

        {

          "feature_id": "f1000055DC",

          "name": "Характеристика",

          "indexable": true,

          "value": ""

        },

        {

          "feature_id": "f1000080DC",

          "name": "Упаковка",

          "indexable": true,

          "value": ""

        }

      ],

      "seo": {

        "title": "%name-product%",

        "keywords": "глобальный шаблон keywords %name-product% ",

        "description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"

      }

    }

  ]

}
Copy-icon
Response sample 

{
  "created": 1,
  "updated": 1
}
Copy-icon
Response codes

200 - операция выполнена успешно

Связанные статьи Copy-icon


Микросервисы