/wildberries-api-php

OpenAPIClient-php - Wildberries API продавца v2.18

Primary LanguagePHP

OpenAPIClient-php

Общее описание

<style> .langChange { text-align: left; padding: 2px 222px 2px 18px; } </style> <style> .new {

display: inline-block; padding: 2px 8px; margin: 0; background-color: #ffa500; color: #ffffff; font-size: 13px; vertical-align: middle; line-height: 1.6; border-radius: 4px; font-weight: 600; font-size: 12px; } </style> <style> .newM { padding: 5px 10px; display: inline-block; background-color: #ffa500; color: #ffffff; cursor: pointer; text-align: center; outline: none; margin: 0 5px 5px 5px; #border: 1px solid #07090b; border-radius: 5px; min-width: 60px; font-size: 0.9em; font-weight: bold; } </style>

Wildberries API предоставляет продавцам возможность управления магазином и получения оперативной и статистической информации по протоколу HTTP RestAPI.
Описание API предоставляется в формате Swagger (Open API) и может быть использовано для импорта в другие инструменты (такие как PostMan) или генерации клиентского кода на различных языках программирования с помощью Swagger CodeGen

  • Описание в оригинальном swagger-формате swagger
  • OpenAPI-файл swagger.yaml


Для ручной провеПродвижение /и API вы можете использовать:

  • Под ОС Windows - PostMan
  • Под ОС Linux - curl

Поддержка

Техническая поддержка осуществляется через диалоги в личном кабинете продавца. При создании нового обращения в техподдержку используйте категорию API.
Новости и изменения, касающиеся API, публикуются в новостной ленте Wildberries.


Авторизация

Авторизация осуществляется по токенам API, которые владелец личного кабинета (главный пользователь) самостоятельно генерирует в разделе Профиль --> Настройки --> Доступ к API.

Существует три типа токенов:

  1. Стандартный. Используется для работы с методами из разделов: Цены, Промокоды и скидки, Контент, Marketplace, Рекомендации, Отзывы, Вопросы.
  2. Статистика. Используется для работы с методами из раздела Статистика.
  3. Продвижение. Используется для работы с методами из раздела Продвижение.

Обратите внимание, что токен отображается ТОЛЬКО в момент создания. Его надо сохранить, потому что больше его отобразить будет нельзя.
Созданный токен следует добавлять в каждый запрос, прибавляя к запросу заголовок (http-header) формата Authorization: ..........

Обращаем ваше внимание, что интеграции с Порталом Продавца, не использующие Публичное API, противоречат пункту 9.7.6 оферты.
Тем не менее, при отсутствии прямой угрозы утечки данных из личного кабинета продавца Wildberries заранее уведомит продавца о запланированной блокировке, связанной с этим пунктом, давая возможность отключить интеграцию.


Форматы

Дата и время

Во всех методах API статистики дата и время передаются в формате RFC3339.
В большинстве случаев вы можете передать дату или дату со временем. Если время не указано, оно принимается равным 00:00:00. Время можно указывать с точностью до секунд или миллисекунд. Литера Z в конце строки означает часовой пояс UTC. При ее отсутствии время считается в часовом поясе МСК (UTC+3).
Примеры:

  • 2019-06-20
  • 2019-06-20T00:00:00Z
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345Z
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00

Release Notes

Для просмотра обновлений перейдите по ссылке.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: HeaderApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 1234; // int | Идентификатор кампании
$subject_id = 1234; // int | Идентификатор предметной группы, для которой меняется активность
$status = true; // string | Новое состояние (`true` - сделать группу активной или `false` - сделать группу неактивной)

try {
    $apiInstance->advV0ActiveGet($id, $subject_id, $status);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->advV0ActiveGet: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
DefaultApi advV0ActiveGet GET /adv/v0/active Изменение активности предметной группы для кампании в поиске
DefaultApi advV0AdvertGet GET /adv/v0/advert Информация о кампании
DefaultApi advV0AdvertsCreatePost POST /adv/v0/adverts/create Создание кампании, тестовый
DefaultApi advV0AdvertsGet GET /adv/v0/adverts Список кампаний
DefaultApi advV0AllcpmPost POST /adv/v0/allcpm Список ставок по типу размещения кампании
DefaultApi advV0CountGet GET /adv/v0/count Получение кампаний
DefaultApi advV0CpmGet GET /adv/v0/cpm Список ставок
DefaultApi advV0CpmPost POST /adv/v0/cpm Изменение ставки у кампании
DefaultApi advV0IntervalsPost POST /adv/v0/intervals Изменение интервалов показа кампании
DefaultApi advV0NmactivePost POST /adv/v0/nmactive Изменение активности номенклатур кампании
DefaultApi advV0ParamsMenuGet GET /adv/v0/params/menu Словарь значений параметра menuId
DefaultApi advV0ParamsSetGet GET /adv/v0/params/set Словарь значений параметра setId
DefaultApi advV0ParamsSubjectGet GET /adv/v0/params/subject Словарь значений параметра subjectId
DefaultApi advV0PauseGet GET /adv/v0/pause Пауза кампании
DefaultApi advV0RenamePost POST /adv/v0/rename Переименование кампании
DefaultApi advV0StartGet GET /adv/v0/start Запуск кампании
DefaultApi advV0StopGet GET /adv/v0/stop Завершение кампании
DefaultApi advV1AutoActivePost POST /adv/v1/auto/active Управление зонами показов в автоматической кампании
DefaultApi advV1AutoGetnmtoaddGet GET /adv/v1/auto/getnmtoadd Список номенклатур для автоматической кампании
DefaultApi advV1AutoStatGet GET /adv/v1/auto/stat Статистика автоматической кампании
DefaultApi advV1AutoUpdatenmPost POST /adv/v1/auto/updatenm Изменение списка номенклатур в автоматической кампании
DefaultApi advV1BalanceGet GET /adv/v1/balance Баланс
DefaultApi advV1BudgetDepositPost POST /adv/v1/budget/deposit Пополнение бюджета кампании
DefaultApi advV1BudgetGet GET /adv/v1/budget Бюджет кампании
DefaultApi advV1FullstatGet GET /adv/v1/fullstat Полная статистика кампании
DefaultApi advV1PaymentsGet GET /adv/v1/payments Получение истории пополнений счета
DefaultApi advV1SaveAdPost POST /adv/v1/save-ad Создание кампании
DefaultApi advV1SeacatStatGet GET /adv/v1/seacat/stat Статистика кампаний Поиск + Каталог
DefaultApi advV1SearchSetExcludedPost POST /adv/v1/search/set-excluded Установка/удаление минус-фраз из поиска для кампании в поиске
DefaultApi advV1SearchSetPhrasePost POST /adv/v1/search/set-phrase Установка/удаление минус-фраз фразового соответствия для кампании в поиске
DefaultApi advV1SearchSetPlusGet GET /adv/v1/search/set-plus Управление активностью фиксированных фраз у кампании в поиске
DefaultApi advV1SearchSetPlusPost POST /adv/v1/search/set-plus Установка/удаление фиксированных фраз у кампании в поиске
DefaultApi advV1SearchSetStrongPost POST /adv/v1/search/set-strong Установка/удаление минус-фраз точного соответствия для кампании в поиске
DefaultApi advV1StatWordsGet GET /adv/v1/stat/words Статистика поисковой кампании по ключевым фразам
DefaultApi advV1UpdGet GET /adv/v1/upd Получение истории затрат
DefaultApi advV1UpdIntervalsGet GET /adv/v1/upd/intervals Получение месячных интервалов для истории затрат
DefaultApi apiV1DelPost POST /api/v1/del Удаление рекомендаций
DefaultApi apiV1FeedbackGet GET /api/v1/feedback Получить отзыв по Id
DefaultApi apiV1FeedbacksArchiveGet GET /api/v1/feedbacks/archive Список архивных отзывов
DefaultApi apiV1FeedbacksCountGet GET /api/v1/feedbacks/count Количество отзывов
DefaultApi apiV1FeedbacksCountUnansweredGet GET /api/v1/feedbacks/count-unanswered Необработанные отзывы
DefaultApi apiV1FeedbacksGet GET /api/v1/feedbacks Список отзывов
DefaultApi apiV1FeedbacksPatch PATCH /api/v1/feedbacks Работа с отзывом
DefaultApi apiV1FeedbacksProductsRatingGet GET /api/v1/feedbacks/products/rating Средняя оценка товаров по родительской категории
DefaultApi apiV1FeedbacksProductsRatingNmidGet GET /api/v1/feedbacks/products/rating/nmid Средняя оценка товара по артикулу WB
DefaultApi apiV1FeedbacksProductsRatingTopGet GET /api/v1/feedbacks/products/rating/top Товары с наибольшей и наименьшей средней оценкой по родительской категории
DefaultApi apiV1FeedbacksReportGet GET /api/v1/feedbacks/report Получение отзывов в формате XLSX
DefaultApi apiV1InsPost POST /api/v1/ins Добавление рекомендаций
DefaultApi apiV1ListPost POST /api/v1/list Список рекомендаций
DefaultApi apiV1NewFeedbacksQuestionsGet GET /api/v1/new-feedbacks-questions Непросмотренные отзывы и вопросы
DefaultApi apiV1ParentSubjectsGet GET /api/v1/parent-subjects Родительские категории товаров
DefaultApi apiV1QuestionGet GET /api/v1/question Получить вопрос по Id
DefaultApi apiV1QuestionsCountGet GET /api/v1/questions/count Количество вопросов
DefaultApi apiV1QuestionsCountUnansweredGet GET /api/v1/questions/count-unanswered Неотвеченные вопросы
DefaultApi apiV1QuestionsGet GET /api/v1/questions Список вопросов
DefaultApi apiV1QuestionsPatch PATCH /api/v1/questions Работа с вопросами
DefaultApi apiV1QuestionsProductsRatingGet GET /api/v1/questions/products/rating Часто спрашиваемые товары
DefaultApi apiV1QuestionsReportGet GET /api/v1/questions/report Получение вопросов в формате XLSX
DefaultApi apiV1SetPost POST /api/v1/set Управление рекомендациями
DefaultApi apiV1SupplierIncomesGet GET /api/v1/supplier/incomes Поставки
DefaultApi apiV1SupplierOrdersGet GET /api/v1/supplier/orders Заказы
DefaultApi apiV1SupplierReportDetailByPeriodGet GET /api/v1/supplier/reportDetailByPeriod Отчет о продажах по реализации
DefaultApi apiV1SupplierSalesGet GET /api/v1/supplier/sales Продажи
DefaultApi apiV1SupplierStocksGet GET /api/v1/supplier/stocks Склад
DefaultApi apiV1TemplatesDelete DELETE /api/v1/templates Удалить шаблон
DefaultApi apiV1TemplatesGet GET /api/v1/templates Получить шаблоны ответов
DefaultApi apiV1TemplatesPatch PATCH /api/v1/templates Редактировать шаблон
DefaultApi apiV1TemplatesPost POST /api/v1/templates Создать шаблон
DefaultApi contentV1AnalyticsNmReportDetailHistoryPost POST /content/v1/analytics/nm-report/detail/history Получение статистики КТ по дням/неделям/месяцам по выбранным nmID
DefaultApi contentV1AnalyticsNmReportDetailPost POST /content/v1/analytics/nm-report/detail Получение статистики КТ за выбранный период, по nmID/предметам/брендам/тегам
DefaultApi contentV1AnalyticsNmReportGroupedHistoryPost POST /content/v1/analytics/nm-report/grouped/history Получение статистики КТ по дням/неделям/месяцам за период, сгруппированный по предметам, брендам и тегам
DefaultApi contentV1AnalyticsNmReportGroupedPost POST /content/v1/analytics/nm-report/grouped Получение статистики КТ за период, сгруппированный по предметам, брендам и тегам
DefaultApi contentV1BarcodesPost POST /content/v1/barcodes Генерация баркодов
DefaultApi contentV1CardsCursorListPost POST /content/v1/cards/cursor/list Список НМ
DefaultApi contentV1CardsErrorListGet GET /content/v1/cards/error/list Список несозданных НМ с ошибками
DefaultApi contentV1CardsFilterPost POST /content/v1/cards/filter Получение КТ по артикулам продавца
DefaultApi contentV1CardsLimitsGet GET /content/v1/cards/limits Лимиты по КТ
DefaultApi contentV1CardsMoveNmPost POST /content/v1/cards/moveNm Объединение / Разъединение НМ
DefaultApi contentV1CardsTrashListPost POST /content/v1/cards/trash/list Список НМ, находящихся в корзине
DefaultApi contentV1CardsUpdatePost POST /content/v1/cards/update Редактирование КТ
DefaultApi contentV1CardsUploadAddPost POST /content/v1/cards/upload/add Добавление НМ к КТ
DefaultApi contentV1CardsUploadPost POST /content/v1/cards/upload Создание КТ
DefaultApi contentV1DirectoryBrandsGet GET /content/v1/directory/brands Бренд
DefaultApi contentV1DirectoryColorsGet GET /content/v1/directory/colors Цвет
DefaultApi contentV1DirectoryCountriesGet GET /content/v1/directory/countries Страна Производства
DefaultApi contentV1DirectoryKindsGet GET /content/v1/directory/kinds Пол
DefaultApi contentV1DirectorySeasonsGet GET /content/v1/directory/seasons Сезон
DefaultApi contentV1DirectoryTnvedGet GET /content/v1/directory/tnved ТНВЭД код
DefaultApi contentV1MediaFilePost POST /content/v1/media/file Добавление медиа контента в КТ
DefaultApi contentV1MediaSavePost POST /content/v1/media/save Изменение медиа контента КТ
DefaultApi contentV1ObjectAllGet GET /content/v1/object/all Категория товаров
DefaultApi contentV1ObjectCharacteristicsListFilterGet GET /content/v1/object/characteristics/list/filter Характеристики для создания КТ по всем подкатегориям
DefaultApi contentV1ObjectCharacteristicsObjectNameGet GET /content/v1/object/characteristics/{objectName} Характеристики для создания КТ для категории товара
DefaultApi contentV1ObjectParentAllGet GET /content/v1/object/parent/all Родительские категории товаров
DefaultApi contentV1TagIdDelete DELETE /content/v1/tag/{id} Удаление тега
DefaultApi contentV1TagIdPatch PATCH /content/v1/tag/{id} Изменение тега
DefaultApi contentV1TagNomenclatureLinkPost POST /content/v1/tag/nomenclature/link Управление тегами в КТ
DefaultApi contentV1TagPost POST /content/v1/tag Создание тега
DefaultApi contentV1TagsGet GET /content/v1/tags Список тегов
DefaultApi publicApiV1InfoGet GET /public/api/v1/info Получение информации о ценах.
DefaultApi publicApiV1PricesPost POST /public/api/v1/prices Загрузка цен
DefaultApi publicApiV1RevokeDiscountsPost POST /public/api/v1/revokeDiscounts Сброс скидок для номенклатур
DefaultApi publicApiV1RevokePromocodesPost POST /public/api/v1/revokePromocodes Сброс промокодов для номенклатур
DefaultApi publicApiV1UpdateDiscountsPost POST /public/api/v1/updateDiscounts Установка скидок
DefaultApi publicApiV1UpdatePromocodesPost POST /public/api/v1/updatePromocodes Установка промокодов для номенклатур
MarketplaceApi apiV3FilesOrdersExternalStickersPost POST /api/v3/files/orders/external-stickers Получить список ссылок на этикетки для сборочных заданий, которые требуются при кроссбордере
MarketplaceApi apiV3OfficesGet GET /api/v3/offices Получить список складов WB
MarketplaceApi apiV3OrdersGet GET /api/v3/orders Получить информацию по сборочным заданиям
MarketplaceApi apiV3OrdersNewGet GET /api/v3/orders/new Получить список новых сборочных заданий
MarketplaceApi apiV3OrdersOrderIdCancelPatch PATCH /api/v3/orders/{orderId}/cancel Отменить сборочное задание
MarketplaceApi apiV3OrdersOrderIdMetaDelete DELETE /api/v3/orders/{orderId}/meta Удалить метаданные сборочного задания
MarketplaceApi apiV3OrdersOrderIdMetaGet GET /api/v3/orders/{orderId}/meta Получить метаданные сборочного задания
MarketplaceApi apiV3OrdersOrderIdMetaGtinPut PUT /api/v3/orders/{orderId}/meta/gtin Закрепить за сборочным заданием GTIN
MarketplaceApi apiV3OrdersOrderIdMetaImeiPut PUT /api/v3/orders/{orderId}/meta/imei Закрепить за сборочным заданием IMEI
MarketplaceApi apiV3OrdersOrderIdMetaSgtinPost POST /api/v3/orders/{orderId}/meta/sgtin Закрепить за сборочным заданием КиЗ (маркировку Честного знака)
MarketplaceApi apiV3OrdersOrderIdMetaUinPut PUT /api/v3/orders/{orderId}/meta/uin Закрепить за сборочным заданием УИН (уникальный идентификационный номер)
MarketplaceApi apiV3OrdersStatusPost POST /api/v3/orders/status Получить статусы сборочных заданий
MarketplaceApi apiV3OrdersStickersPost POST /api/v3/orders/stickers Получить этикетки для сборочных заданий
MarketplaceApi apiV3PassesGet GET /api/v3/passes Получить список пропусков
MarketplaceApi apiV3PassesOfficesGet GET /api/v3/passes/offices Получить список складов, для которых требуется пропуск
MarketplaceApi apiV3PassesPassIdDelete DELETE /api/v3/passes/{passId} Удалить пропуск
MarketplaceApi apiV3PassesPassIdPut PUT /api/v3/passes/{passId} Обновить пропуск
MarketplaceApi apiV3PassesPost POST /api/v3/passes Создать пропуск
MarketplaceApi apiV3StocksWarehouseIdDelete DELETE /api/v3/stocks/{warehouseId} Удалить остатки товаров
MarketplaceApi apiV3StocksWarehouseIdPost POST /api/v3/stocks/{warehouseId} Получить остатки товаров
MarketplaceApi apiV3StocksWarehouseIdPut PUT /api/v3/stocks/{warehouseId} Обновить остатки товаров
MarketplaceApi apiV3SuppliesGet GET /api/v3/supplies Получить список поставок
MarketplaceApi apiV3SuppliesPost POST /api/v3/supplies Создать новую поставку
MarketplaceApi apiV3SuppliesSupplyIdBarcodeGet GET /api/v3/supplies/{supplyId}/barcode Получить QR поставки
MarketplaceApi apiV3SuppliesSupplyIdDelete DELETE /api/v3/supplies/{supplyId} Удалить поставку
MarketplaceApi apiV3SuppliesSupplyIdDeliverPatch PATCH /api/v3/supplies/{supplyId}/deliver Передать поставку в доставку
MarketplaceApi apiV3SuppliesSupplyIdGet GET /api/v3/supplies/{supplyId} Получить информацию о поставке
MarketplaceApi apiV3SuppliesSupplyIdOrdersGet GET /api/v3/supplies/{supplyId}/orders Получить сборочные задания в поставке
MarketplaceApi apiV3SuppliesSupplyIdOrdersOrderIdPatch PATCH /api/v3/supplies/{supplyId}/orders/{orderId} Добавить к поставке сборочное задание
MarketplaceApi apiV3SuppliesSupplyIdTrbxDelete DELETE /api/v3/supplies/{supplyId}/trbx Удалить короба из поставки
MarketplaceApi apiV3SuppliesSupplyIdTrbxGet GET /api/v3/supplies/{supplyId}/trbx Получить список коробов поставки
MarketplaceApi apiV3SuppliesSupplyIdTrbxPost POST /api/v3/supplies/{supplyId}/trbx Добавить короба к поставке
MarketplaceApi apiV3SuppliesSupplyIdTrbxStickersPost POST /api/v3/supplies/{supplyId}/trbx/stickers Получить стикеры коробов поставки
MarketplaceApi apiV3SuppliesSupplyIdTrbxTrbxIdOrdersOrderIdDelete DELETE /api/v3/supplies/{supplyId}/trbx/{trbxId}/orders/{orderId} Удалить заказ из короба
MarketplaceApi apiV3SuppliesSupplyIdTrbxTrbxIdPatch PATCH /api/v3/supplies/{supplyId}/trbx/{trbxId} Добавить заказы к коробу
MarketplaceApi apiV3WarehousesGet GET /api/v3/warehouses Получить список складов продавца
MarketplaceApi apiV3WarehousesPost POST /api/v3/warehouses Создать склад продавца
MarketplaceApi apiV3WarehousesWarehouseIdDelete DELETE /api/v3/warehouses/{warehouseId} Удалить склад продавца
MarketplaceApi apiV3WarehousesWarehouseIdPut PUT /api/v3/warehouses/{warehouseId} Обновить склад

Models

Authorization

Authentication schemes defined for the API:

HeaderApiKey

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 2.18
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen