itfrogs/wildberries

There is no license information available for the latest version (dev-master) of this package.

A short description of what your package does

Maintainers

Details

github.com/itfrogs/wildberries

Source

Issues

Installs: 1

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

dev-master 2022-11-07 11:16 UTC

Requires

Unknown License 81bd0fe1e245e99115b2a251887dd227cb0f47f0

This package is auto-updated.

Last update: 2024-06-07 14:51:57 UTC

README

Общее описание <style> .version { border: 0.1rem #b3b3b3 solid ; background-color: #F9F9F9; color: #32329FE6; height: 25px; width: 150px; text-align: center } </style> Wildberries API предоставляет продавцам возможность управления магазином и получения оперативной и статистической информации по протоколу HTTP RestAPI.
Описание API предоставляется в формате Swagger (Open API) и может быть использовано для импорта в другие инструменты (такие как PostMan) или генерации клиентского кода на различных языках программирования с помощью Swagger CodeGen

  • Описание в оригинальном swagger-формате <a href="/swagger">swagger
  • OpenAPI-файл <a href="/swagger.yaml">swagger.yaml

Для ручной проверки API вы можете использовать:
  • Под ОС Windows - PostMan
  • Под ОС Linux - curl
## Поддержка
Техническая поддержка осуществляется через обращения в личном кабинете продавца. При создании нового обращения в техподдержку используйте категорию API.
Новости и изменения, касающиеся API, публикуются в новостной ленте Wildberries.
Также готовятся к публикации Release Notes по API на сайте. После их выхода будет сделан соответствующий анонс. ## Авторизация Вызов любого метода API должен быть авторизован. Авторизация осуществляется по ключам API, которые владелец личного кабинета (главный пользователь) самостоятельно генерирует в разделе Профиль --> Настройки --> Доступ к API для статистики и Профиль --> Настройки --> Доступ к новому API для остальных методов. Ключ должен передаваться в каждом HTTP-запросе. ### Авторизация для методов Статистики При работе с методами Статистики ключ авторизации генерируется в разделе "Профиль --> Настройки --> Доступ к API".
Созданный ключ отображается в личном кабинете как "Ключ для работы с API статистики x64".
Его следует скопировать и добавлять в каждый запрос, прибавляя к запросу параметр key.
Выглядеть запрос будет примерно так: https://suppliers-stats.wildberries.ru/api/v1/supplier/stocks?dateFrom=2022-03-25&key=xxxxxxxxxx ### Авторизация для нестатистических методов При работе со всеми методами кроме статистики ключ авторизации генерируется в разделе "Профиль --> Настройки --> Доступ к новому API".
Обратите внимание, что ключ отображается ТОЛЬКО в момент создания. Его надо сохранить, потому что больше его отобразить будет нельзя.
Созданный ключ следует добавлять в каждый запрос, прибавляя к запросу заголовок (http-header) формата Authorization: xxxxxxxxxx. ## Форматы ### Дата и время Во всех методах 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 #### 2022.10.31 v1.4 Метод будет отключен 2022.10.31 в v1.4:
  • /content/v1/cards/list
#### 2022.09.20 v1.2 В связи с переходом на новое API Контента старые методы будут отключены. К их числу относятся:
  • /card/_*
  • /api/v1/config/_*
  • /api/v1/directory/_*
Данные методы теперь возвращают код 404. Новое API Контента описано в данном документе в разделах Контент / *

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 1.4
  • Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "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:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

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

$apiInstance = new Swagger\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
);
$key = "key_example"; // string | Ключ аутентификации.<br>  Генерируется самостоятельно на портале Продавца в разделе «Профиль» - «Настройки» - «Доступ к API».
$date_from = "date_from_example"; // string | Дата в формате RFC3339. Можно передать дату или дату со временем.  Время можно указывать с точностью до секунд или миллисекунд.  Литера `Z` в конце строки означает, что время передается в UTC-часовом поясе.  При ее отсутствии время считается в часовом поясе МСК (UTC+3). <br>Примеры: <ul> <li> `2019-06-20` <li> `2019-06-20T00:00:00Z` <li> `2019-06-20T23:59:59` <li> `2019-06-20T00:00:00.12345Z` <li> `2019-06-20T00:00:00.12345` <li> `2017-03-25T00:00:00` </ul>

try {
    $result = $apiInstance->apiV1SupplierExciseGoodsGet($key, $date_from);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->apiV1SupplierExciseGoodsGet: ', $e->getMessage(), PHP_EOL;
}

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

$apiInstance = new Swagger\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
);
$key = "key_example"; // string | Ключ аутентификации.<br>  Генерируется самостоятельно на портале Продавца в разделе «Профиль» - «Настройки» - «Доступ к API».
$date_from = "date_from_example"; // string | Дата в формате RFC3339. Можно передать дату или дату со временем.  Время можно указывать с точностью до секунд или миллисекунд.  Литера `Z` в конце строки означает, что время передается в UTC-часовом поясе.  При ее отсутствии время считается в часовом поясе МСК (UTC+3). <br>Примеры: <ul> <li> `2019-06-20` <li> `2019-06-20T00:00:00Z` <li> `2019-06-20T23:59:59` <li> `2019-06-20T00:00:00.12345Z` <li> `2019-06-20T00:00:00.12345` <li> `2017-03-25T00:00:00` </ul>

try {
    $result = $apiInstance->apiV1SupplierIncomesGet($key, $date_from);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->apiV1SupplierIncomesGet: ', $e->getMessage(), PHP_EOL;
}

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

$apiInstance = new Swagger\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
);
$key = "key_example"; // string | Ключ аутентификации.<br>  Генерируется самостоятельно на портале Продавца в разделе «Профиль» - «Настройки» - «Доступ к API».
$date_from = "date_from_example"; // string | Дата в формате RFC3339. Можно передать дату или дату со временем.  Время можно указывать с точностью до секунд или миллисекунд.  Литера `Z` в конце строки означает, что время передается в UTC-часовом поясе.  При ее отсутствии время считается в часовом поясе МСК (UTC+3). <br>Примеры: <ul> <li> `2019-06-20` <li> `2019-06-20T00:00:00Z` <li> `2019-06-20T23:59:59` <li> `2019-06-20T00:00:00.12345Z` <li> `2019-06-20T00:00:00.12345` <li> `2017-03-25T00:00:00` </ul>
$flag = 0; // int | Если параметр `flag=0` (или не указан в строке запроса), при вызове API возвращаются данные,  у которых значение поля `lastChangeDate` (дата время обновления информации в сервисе) больше или равно переданному  значению параметра `dateFrom`.  При этом количество возвращенных строк данных варьируется в интервале от 0 до примерно 100 000. <br> Если параметр `flag=1`, то будет выгружена информация обо всех заказах или продажах с датой,  равной переданному параметру `dateFrom` (в данном случае время в дате значения не имеет).  При этом количество возвращенных строк данных будет равно количеству всех заказов или продаж,  сделанных в указанную дату, переданную в параметре `dateFrom`.

try {
    $result = $apiInstance->apiV1SupplierOrdersGet($key, $date_from, $flag);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->apiV1SupplierOrdersGet: ', $e->getMessage(), PHP_EOL;
}

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

$apiInstance = new Swagger\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
);
$key = "key_example"; // string | Ключ аутентификации.<br>  Генерируется самостоятельно на портале Продавца в разделе «Профиль» - «Настройки» - «Доступ к API».
$date_from = "date_from_example"; // string | Дата в формате RFC3339. Можно передать дату или дату со временем.  Время можно указывать с точностью до секунд или миллисекунд.  Литера `Z` в конце строки означает, что время передается в UTC-часовом поясе.  При ее отсутствии время считается в часовом поясе МСК (UTC+3). <br>Примеры: <ul> <li> `2019-06-20` <li> `2019-06-20T00:00:00Z` <li> `2019-06-20T23:59:59` <li> `2019-06-20T00:00:00.12345Z` <li> `2019-06-20T00:00:00.12345` <li> `2017-03-25T00:00:00` </ul>
$date_to = new \DateTime("2013-10-20"); // \DateTime | Конечная дата отчета
$limit = 0; // int | Максимальное количество строк отчета, возвращаемых методом. Не может быть более 100 000.
$rrdid = 56; // int | Уникальный идентификатор строки отчета. Необходим для получения отчета частями.  <br> Загрузку отчета нужно начинать с `rrdid = 0` и при последующих вызовах API передавать в запросе значение `rrd_id` из последней строки, полученной в результате предыдущего вызова.  <br> Таким образом для загрузки одного отчета может понадобиться вызывать API до тех пор, пока количество возвращаемых строк не станет равным нулю.

try {
    $result = $apiInstance->apiV1SupplierReportDetailByPeriodGet($key, $date_from, $date_to, $limit, $rrdid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->apiV1SupplierReportDetailByPeriodGet: ', $e->getMessage(), PHP_EOL;
}

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

$apiInstance = new Swagger\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
);
$key = "key_example"; // string | Ключ аутентификации.<br>  Генерируется самостоятельно на портале Продавца в разделе «Профиль» - «Настройки» - «Доступ к API».
$date_from = "date_from_example"; // string | Дата в формате RFC3339. Можно передать дату или дату со временем.  Время можно указывать с точностью до секунд или миллисекунд.  Литера `Z` в конце строки означает, что время передается в UTC-часовом поясе.  При ее отсутствии время считается в часовом поясе МСК (UTC+3). <br>Примеры: <ul> <li> `2019-06-20` <li> `2019-06-20T00:00:00Z` <li> `2019-06-20T23:59:59` <li> `2019-06-20T00:00:00.12345Z` <li> `2019-06-20T00:00:00.12345` <li> `2017-03-25T00:00:00` </ul>
$flag = 0; // int | Если параметр `flag=0` (или не указан в строке запроса), при вызове API возвращаются данные,  у которых значение поля `lastChangeDate` (дата время обновления информации в сервисе) больше или равно переданному  значению параметра `dateFrom`.  При этом количество возвращенных строк данных варьируется в интервале от 0 до примерно 100 000. <br> Если параметр `flag=1`, то будет выгружена информация обо всех заказах или продажах с датой,  равной переданному параметру `dateFrom` (в данном случае время в дате значения не имеет).  При этом количество возвращенных строк данных будет равно количеству всех заказов или продаж,  сделанных в указанную дату, переданную в параметре `dateFrom`.

try {
    $result = $apiInstance->apiV1SupplierSalesGet($key, $date_from, $flag);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->apiV1SupplierSalesGet: ', $e->getMessage(), PHP_EOL;
}

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

$apiInstance = new Swagger\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
);
$key = "key_example"; // string | Ключ аутентификации.<br>  Генерируется самостоятельно на портале Продавца в разделе «Профиль» - «Настройки» - «Доступ к API».
$date_from = "date_from_example"; // string | Дата в формате RFC3339. Можно передать дату или дату со временем.  Время можно указывать с точностью до секунд или миллисекунд.  Литера `Z` в конце строки означает, что время передается в UTC-часовом поясе.  При ее отсутствии время считается в часовом поясе МСК (UTC+3). <br>Примеры: <ul> <li> `2019-06-20` <li> `2019-06-20T00:00:00Z` <li> `2019-06-20T23:59:59` <li> `2019-06-20T00:00:00.12345Z` <li> `2019-06-20T00:00:00.12345` <li> `2017-03-25T00:00:00` </ul>

try {
    $result = $apiInstance->apiV1SupplierStocksGet($key, $date_from);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->apiV1SupplierStocksGet: ', $e->getMessage(), PHP_EOL;
}

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

$apiInstance = new Swagger\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
);
$quantity = 56; // int | `2` - товар с нулевым остатком, `1` - товар с ненулевым остатком, `0` - товар с любым остатком

try {
    $result = $apiInstance->publicApiV1InfoGet($quantity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->publicApiV1InfoGet: ', $e->getMessage(), PHP_EOL;
}

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

$apiInstance = new Swagger\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
);
$body = array(new \Swagger\Client\Model\V1PricesBody()); // \Swagger\Client\Model\V1PricesBody[] | 

try {
    $apiInstance->publicApiV1PricesPost($body);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->publicApiV1PricesPost: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to /

Class Method HTTP request Description
DefaultApi apiV1SupplierExciseGoodsGet GET /api/v1/supplier/excise-goods Отчет по КиЗам
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 publicApiV1InfoGet GET /public/api/v1/info Получение информации о ценах.
DefaultApi publicApiV1PricesPost POST /public/api/v1/prices Загрузка цен
MarketplaceApi apiV2OrdersGet GET /api/v2/orders Список сборочных заданий
MarketplaceApi apiV2OrdersPut PUT /api/v2/orders Обновление статуса сборочных заданий
MarketplaceApi apiV2OrdersStickersPdfPost POST /api/v2/orders/stickers/pdf Cписок QR стикеров в формате pdf
MarketplaceApi apiV2OrdersStickersPost POST /api/v2/orders/stickers Cписок этикеток сборочных заданий
MarketplaceApi apiV2StocksDelete DELETE /api/v2/stocks Удаление остатков товара
MarketplaceApi apiV2StocksGet GET /api/v2/stocks Список товаров с остатками
MarketplaceApi apiV2StocksPost POST /api/v2/stocks Обновление остатков товара
MarketplaceApi apiV2SuppliesGet GET /api/v2/supplies Список поставок
MarketplaceApi apiV2SuppliesIdBarcodeGet GET /api/v2/supplies/{id}/barcode Штрихкод поставки в заданном формате
MarketplaceApi apiV2SuppliesIdClosePost POST /api/v2/supplies/{id}/close Закрытие поставки
MarketplaceApi apiV2SuppliesIdOrdersGet GET /api/v2/supplies/{id}/orders Список заказов, закреплённых за поставкой
MarketplaceApi apiV2SuppliesIdPut PUT /api/v2/supplies/{id} Добавление к поставке заказов
MarketplaceApi apiV2SuppliesPost POST /api/v2/supplies Новая поставка
MarketplaceApi apiV2WarehousesGet GET /api/v2/warehouses Cписок складов
_Api contentV1BarcodesPost POST /content/v1/barcodes Генерация баркодов
_Api contentV1CardsCursorListPost POST /content/v1/cards/cursor/list Список НМ v2
_Api contentV1CardsErrorListGet GET /content/v1/cards/error/list Список несозданных НМ с ошибками
_Api contentV1CardsFilterPost POST /content/v1/cards/filter Получение КТ по вендор кодам (артикулам)
_Api contentV1CardsUpdatePost POST /content/v1/cards/update Редактирование КТ
_Api contentV1CardsUploadAddPost POST /content/v1/cards/upload/add Добавление НМ к КТ
_Api contentV1CardsUploadPost POST /content/v1/cards/upload Создание КТ
_Api contentV1DirectoryBrandsGet GET /content/v1/directory/brands Бренд
_Api contentV1DirectoryCollectionsGet GET /content/v1/directory/collections Коллекция
_Api contentV1DirectoryColorsGet GET /content/v1/directory/colors Цвет
_Api contentV1DirectoryConsistsGet GET /content/v1/directory/consists Состав
_Api contentV1DirectoryContentsGet GET /content/v1/directory/contents Комплектация
_Api contentV1DirectoryCountriesGet GET /content/v1/directory/countries Страна Производства
_Api contentV1DirectoryKindsGet GET /content/v1/directory/kinds Пол
_Api contentV1DirectorySeasonsGet GET /content/v1/directory/seasons Сезон
_Api contentV1DirectoryTnvedGet GET /content/v1/directory/tnved ТНВЭД код
_Api contentV1MediaFilePost POST /content/v1/media/file Добавление медиа контента в КТ
_Api contentV1MediaSavePost POST /content/v1/media/save Изменение медиа контента КТ
_Api contentV1ObjectAllGet GET /content/v1/object/all Категория товаров
_Api contentV1ObjectCharacteristicsListFilterGet GET /content/v1/object/characteristics/list/filter Характеристики для создания КТ по всем подкатегориям
_Api contentV1ObjectCharacteristicsObjectNameGet GET /content/v1/object/characteristics/{objectName} Характеристики для создания КТ для категории товара
_Api contentV1ObjectParentAllGet GET /content/v1/object/parent/all Родительские категории товаров
_Api publicApiV1RevokeDiscountsPost POST /public/api/v1/revokeDiscounts Сброс скидок для номенклатур
_Api publicApiV1RevokePromocodesPost POST /public/api/v1/revokePromocodes Сброс промокодов для номенклатур
_Api publicApiV1UpdateDiscountsPost POST /public/api/v1/updateDiscounts Установка скидок
_Api publicApiV1UpdatePromocodesPost POST /public/api/v1/updatePromocodes Установка промокодов для номенклатур

Documentation For Models

Documentation For Authorization

ApiKey

  • Type: API key
  • API key parameter name: key
  • Location: URL query string

HeaderApiKey

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

Author