Substitutions and Incorrect Attachments

GET /api/analytics/v1/deductions

Base URL: https://seller-analytics-api.wildberries.ru · Module: reports · Section: Retention Reports · Specification doc ↗

The method returns a report with substitutions and incorrect attachments retentions

Request limit per one seller account:

Type	Period	Limit	Interval	Burst
Personal	1 min	1 request	1 min	1 request
Service	1 min	1 request	1 min	1 request
Base with secret	1 min	1 request	1 min	1 request
Base	1 h	4 requests	15 min	1 request

Parameters

Name	In	Type	Req.	Description
dateFrom	query	string	no	Report period start. By default the date and time when data for the report was first received is used
dateTo	query	string	yes	Report period end
sort	query	string	no	Sorting: - nmId — by WB item number - dtBonus — by fine date and time - bonusSumm — by fine amount
order	query	string	no	Data order: - desc — descending - asc — ascending
limit	query	integer<int64>	yes	Number of retentions in the response
offset	query	integer<int64>	no	How many results to skip. For example, with value 10, the response will start with the 11 element

Responses

Code	Description	Schema
200	Успешно	object
400	Bad request	Response400Retentions
401	Unauthorized	object
402	Payment required	object
403	Access denied	Response403Retentions
429	Too many requests	object

Structure 200:

• data object (required) — Response data
  • reports object[] (required) — Retentions
    • dtBonus string — Fine date and time
    • nmId integer<int64> — WB item number
    • oldShkId integer<int64> — Old item No.
    • oldColor string — Old color
    • oldSize string — Old Size
    • oldSku string — Old SKU
    • oldVendorCode string — Old seller supplierArticle
    • newShkId integer<int64> — New item No.
    • newColor string — New color
    • newSize string — New size
    • newSku string — New SKU
    • newVendorCode string — New seller item number
    • bonusSumm number — Fine amount
    • bonusType string — Fine reason
    • photoUrls string[] — Photos of the measurements
  • total integer<int64> (required) — Number of retentions in the report. Except limit and offset

Structure 400:

• title string — Error title
• status integer<int64> — HTTP status code
• detail string — Error details
• requestId string — Unique request ID
• origin string — WB internal service ID

Structure 401:

• title string — Error title
• detail string — Error details
• code string — Internal error code
• requestId string — Unique request ID
• origin string — WB internal service ID
• status number — HTTP status code
• statusText string — Text of the HTTP status code
• timestamp string — Request date and time

Structure 402:

• title string — Error title
• detail string — Error details. The error is only returned to services from the Solutions for business Catalog

Structure 403:

• title string — Error title
• status integer<int64> — HTTP status code
• detail string — Error details
• requestId string — Unique request ID
• origin string — WB internal service ID

Structure 429:

• title string — Error title
• detail string — Error details
• code string — Internal error code
• requestId string — Unique request ID
• origin string — WB internal service ID
• status number — HTTP status code
• statusText string — Text of the HTTP status code
• timestamp string — Request date and time

Call examples

Arguments are shown as parameter names — substitute your own values. Languages whose client does not expose this operation are omitted.

Python

from wb_api_client.reports import Configuration, ApiClient
from wb_api_client.reports.api import ReportsApi

cfg = Configuration(access_token="<your WB JWT>")
api = ReportsApi(ApiClient(cfg))

result = api.get_v1_deductions(date_to=..., limit=..., date_from=..., sort=..., order=..., offset=...)
print(result)

TypeScript

import {
  Configuration,
  ReportsApi,
} from "@valeryverkhoturov/wb-api-client/reports";

const cfg = new Configuration({});
cfg.setAccessToken("<your WB JWT>");
const api = new ReportsApi(cfg);

const { data } = await api.getV1Deductions(dateTo, limit, dateFrom, sort, order, offset);
console.log(data);

Go

import (
	"context"
	"fmt"

	wbreports "github.com/ValeryVerkhoturov/wb-api-client-go/reports"
)

cfg := wbreports.NewConfiguration()
cfg.SetAccessToken("<your WB JWT>")
client := wbreports.NewAPIClient(cfg)

result, _, err := client.ReportsAPI.GetV1Deductions(context.Background()).DateTo(dateTo).Limit(limit).Execute()
if err != nil {
    panic(err)
}
fmt.Printf("%+v\n", result)

Java

import io.github.valeryverkhoturov.wbapi.reports.ApiClient;
import io.github.valeryverkhoturov.wbapi.reports.SecretString;
import io.github.valeryverkhoturov.wbapi.reports.api.ReportsApi;

ApiClient client = new ApiClient();
client.setAccessToken(new SecretString("<your WB JWT>"));
ReportsApi api = new ReportsApi(client);

System.out.println(api.getV1Deductions(dateTo, limit, dateFrom, sort, order, offset));

PHP

use ValeryVerkhoturov\WbApiClient\Reports\Configuration;
use ValeryVerkhoturov\WbApiClient\Reports\SecretString;
use ValeryVerkhoturov\WbApiClient\Reports\Api\ReportsApi;
use GuzzleHttp\Client;

$config = (new Configuration())
    ->setAccessTokenSecret(new SecretString('<your WB JWT>'));
$api = new ReportsApi(new Client(), $config);

print_r($api->getV1Deductions($date_to, $limit));

OneScript

#Использовать "wb-api-client"

Настройки = Новый Конфигурация();
Настройки.УстановитьТокен("<your WB JWT>");
Клиент = Новый ReportsApi(Настройки);

Сообщить(Клиент.GetV1Deductions(dateTo, limit).Тело);

C#

using ValeryVerkhoturov.WbApiClient.Reports.Api;
using ValeryVerkhoturov.WbApiClient.Reports.Client;

var config = new Configuration();
config.AccessTokenSecret = new SecretString("<your WB JWT>");
var api = new ReportsApi(config);

Console.WriteLine(api.GetV1Deductions(dateTo, limit));

Rust

use wb_api_client::reports::apis::{configuration::Configuration, reports_api};

#[tokio::main]
async fn main() {
    let mut cfg = Configuration::new();
    cfg.set_access_token("<your WB JWT>");

    let result = reports_api::get_v1_deductions(&cfg, date_to, limit, date_from, sort, order, offset).await;
    println!("{:#?}", result);
}