Загрузка остатков товаров с помощью API

Общая информация

API позволяет автоматизировать загрузку и обновление остатков товаров. Для взаимодействия с API используется авторизация по APIKey, который вы можете получить в личном кабинете, в разделе «Мои остатки товаров».

Получение API-ключа

1. Перейдите в раздел «Мои остатки товаров» в личном кабинете.
2. Активируйте способ загрузки «API». Способ загрузки «XML-фид» будет деактивирован автоматически.
3. Нажмите кнопку «Сгенерировать API-ключ».
4. Скопируйте «API-ключ» и используйте его при выполнении запросов.

Авторизация

Для авторизации запросов используется заголовок Authorization:

POST /api/v1/external/stocks HTTP/1.1
Host: https://лд.рф
Content-Type: application/json
Accept: application/json
Authorization: ApiKey <ВАШ_СГЕНЕРИРОВАННЫЙ_API_КЛЮЧ>

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

{
  "result": [
    {
      "productSku": "LD 47.300.15",
      "pointId": "А001",
      "updated": true,
      "errors": []
    },
    {
      "productSku": "11110509402MULD000000000",
      "pointId": "А002",
      "updated": false,
      "errors": [
        { "code": "SKU_NOT_FOUND", "message": "Товар с указанным productSku не найден." },
        { "code": "POINT_NOT_FOUND", "message": "Указанная Вами точка продаж не найдена." },
        { "code": "EMPTY_QUANTITY", "message": "Количество товара на складе не указано или равно нулю." },
        { "code": "EMPTY_PRICE", "message": "Цена товара не указана или равна нулю." }
      ]
    }
  ]
}

Пример ответа при ошибках аутентификации

HTTP/1.1 401 Unauthorized
Content-Type: application/json

{
  "code": "INVALID_APIKEY_FORMAT",
  "message": "Неверный формат API-ключа (ожидается GUID)"
}

Поля запроса

Каждый элемент массива stocks должен содержать поля, необходимые для выбранной операции.

Возможные статусы ошибок

Ограничения

• Не более 5 запросов в минуту. В случае превышения, доступ может быть временно заблокирован.
• Максимальное время ожидания ответа от API — 5 минут. Если за это время сервер не ответит, запрос будет завершён с ошибкой таймаута. Пожалуйста, учитывайте это в своих интеграциях.

Список возможных ошибок валидации

Ошибки аутентификации

При ошибках в заголовке авторизации сервис вернёт HTTP 401 Unauthorized и один из следующих кодов.

Получение списка товаров

Для авторизации запросов используется заголовок Authorization:

POST /api/v1/external/export/products HTTP/1.1
Host: https://лд.рф
Content-Type: application/json
Accept: application/json
Authorization: ApiKey <ВАШ_СГЕНЕРИРОВАННЫЙ_API_КЛЮЧ>

POST Получение списка товаров

URL: /api/v1/external/export/products

Данный эндпоинт позволяет получить данные о всех товарах на сайте лд.рф и их связанные атрибуты.

Можно запросить: идентификаторы товаров, цены РРЦ, персональные цены и МОЦ, артикулы, наименования, свойства, связанные файлы и изображения, а также остатки на доступных складах.
Для оптимизации объёма данных укажите только необходимые поля в массиве SELECT.

Если выполнить запрос без тела запроса, в ответе для каждого товара будет возвращён только один параметр — productSku.

Тело запроса (опционально):

{
  "SELECT": [
    "id",
    "price",
    "prices",
    "productSku",
    "name",
    "properties",
    "documents",
    "pictures",
    "warehouseStocks"
  ]
}

• id — идентификатор товара
• price — цена РРЦ. Если цена отсутствует или на сайте указано «По запросу», возвращается null
• prices — цены товара: персональная цена, МОЦ и РРЦ
• productSku — артикул товара
• name — наименование товара
• properties — свойства товара
• documents — подробная информация о файлах: название, ссылка для скачивания, размер и расширение
• files — файлы. Поле устарело, но оставлено для обратной совместимости; используйте новое поле documents
• pictures — изображения
• warehouseStocks — остатки товара по доступным складам

В ответе будут только те поля, которые вы указали в SELECT.

Поля files и documents возвращаются вместе только при явном указании их в SELECT.

В поле warehouseStocks возвращаются остатки товара по доступным складам. Показываются только положительные остатки. Если остатков нет, список будет пустым.

В поле prices возвращаются цены товара, доступные вашей учётной записи на сайте, в порядке: персональная цена, МОЦ, РРЦ. Персональная цена и МОЦ показываются, только если они установлены. РРЦ показывается всегда. Если РРЦ отсутствует или на сайте указано «По запросу», для неё возвращается "price": null.

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

{
  "products": [
    {
      "id": 1,
      "price": 196378,
      "prices": [
        {
          "priceType": "personal",
          "priceTypeName": "Персональная цена",
          "priceTypeNameShort": "Ваша цена",
          "price": 108007.9
        },
        {
          "priceType": "moc",
          "priceTypeName": "Минимальная оптовая цена",
          "priceTypeNameShort": "МОЦ",
          "price": 137464.6
        },
        {
          "priceType": "retail",
          "priceTypeName": "Рекомендуемая розничная цена",
          "priceTypeNameShort": "РРЦ",
          "price": 196378
        }
      ],
      "productSku": "11111509251RGLD000000000",
      "name": "Кран шаровый LD КШЦФР Gas 150/125.025.Н/П.01. из стали 12Х18Н10Т Ду150/125 Ру2,5МПа с редуктором",
      "properties": [
        {
          "name":"Тип продукта",
          "value":"Кран шаровой"
        },
        {
          "name":"Серия",
          "value":"LD"
        },
        {
          "name":"Рабочая среда",
          "value":"Газ"
        }
      ],
      "documents": [
        {
          "name": "Технический паспорт.pdf",
          "downloadUrl": "https://xn--d1an.xn--p1ai/api/v1/external/document/Zr7upTWBFFWsgbr5/8d1f7e80-997b-11ee-89ce-005056a4b6de.pdf",
          "size": 758952,
          "formattedSize": "741,16 КБ",
          "type": "pdf"
        }
      ],
      "pictures": [
        "https://xn--d1an.xn--p1ai/api/v1/external/product-images/_pMQnb-CWY4saJem/bbe/bbe018b25a032512e1a03985cb2f0ec8.png"
      ],
      "warehouseStocks": [
        {
          "warehouseId": 1,
          "warehouseName": "Склад Челябинск",
          "availableQuantity": 12
        },
        {
          "warehouseId": 2,
          "warehouseName": "Склад Москва",
          "availableQuantity": 15
        }
      ]
    }
  ]
}

Возможные ошибки:

Получение списка доступных складов

Для авторизации запросов используется заголовок Authorization:

GET /api/v1/external/export/warehouses HTTP/1.1
Host: https://лд.рф
Accept: application/json
Authorization: ApiKey <ВАШ_СГЕНЕРИРОВАННЫЙ_API_КЛЮЧ>

GET Получение списка доступных складов

URL: /api/v1/external/export/warehouses

С помощью этого запроса можно получить список доступных складов. Список не зависит от наличия товаров и остатков.

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

{
  "warehouses": [
    {
      "warehouseId": 1,
      "warehouseName": "Склад Челябинск"
    },
    {
      "warehouseId": 2,
      "warehouseName": "Склад Москва"
    }
  ]
}

Если доступных складов нет, метод вернёт пустой список.

Возможные ошибки: