Удержания за занижение габаритов упаковки

GET /api/analytics/v1/measurement-penalties

База: https://seller-analytics-api.wildberries.ru · Модуль: reports · Раздел: Отчёты об удержаниях · Документация спецификации ↗

Метод возвращает отчёт об удержаниях за занижение габаритов упаковки

Лимит запросов на один профиль продавца:

Тип	Период	Лимит	Интервал	Всплеск
Персональный	1 мин	1 запрос	1 мин	1 запрос
Сервисный	1 мин	1 запрос	1 мин	1 запрос
Базовый с секретом	1 мин	1 запрос	1 мин	1 запрос
Базовый	6 ч	1 запрос	6 ч	1 запрос

Параметры

Имя	Где	Тип	Обяз.	Описание
dateFrom	query	string	нет	Начало отчётного периода. По умолчанию используется дата, когда были впервые получены данные для отчёта
dateTo	query	string	да	Конец отчётного периода
limit	query	integer<int64>	да	Количество удержаний в ответе
offset	query	integer<int64>	нет	Сколько элементов пропустить. Например, для значения 10 ответ начнётся с 11 элемента

Ответы

Код	Описание	Схема
200	Успешно	MeasurementPenalties
400	Неправильный запрос	Response400Retentions
401	Не авторизован	object
402	Требуется платёж	object
403	Доступ запрещён	Response403Retentions
429	Слишком много запросов	object

Структура 200:

• data object — Данные ответа
  • reports object[] — Удержания
    • nmId integer<int64> — Артикул WB
    • subjectName string — Предмет
    • dimId integer<int64> — ID замера
    • prcOver number — Разница в габаритах, %
    • volume number — Объём, л (фактические габариты по замеру на складе)
    • width integer<int64> — Ширина, см (фактические габариты по замеру на складе)
    • length integer<int64> — Длина, см (фактические габариты по замеру на складе)
    • height integer<int64> — Высота, см (фактические габариты по замеру на складе)
    • volumeSup number — Объём, л (габариты карточки товара)
    • widthSup integer<int64> — Ширина, см (габариты карточки товара)
    • lengthSup integer<int64> — Длина, см (габариты карточки товара)
    • heightSup integer<int64> — Высота, см (габариты карточки товара)
    • photoUrls string[] — Фото замеров
    • dtBonus string — Дата штрафа
    • isValid boolean — Статус обмера: - false — отменён - true — подтверждён
    • isValidDt string — Дата и время подтверждения или отмены обмера
    • reversalAmount number — Сумма сторно
    • penaltyAmount number — Сумма штрафа
    • dateStart string — Дата и время начала действия коэффициента
    • dateEnd string — Дата и время окончания действия коэффициента
  • total integer<int64> — Количество удержаний в отчёте. Без учёта limit и offset

Структура 400:

• title string — Заголовок ошибки
• status integer<int64> — HTTP статус-код
• detail string — Детали ошибки
• requestId string — Уникальный ID запроса
• origin string — ID внутреннего сервиса WB

Структура 401:

• title string — Заголовок ошибки
• detail string — Детали ошибки
• code string — Внутренний код ошибки
• requestId string — Уникальный ID запроса
• origin string — ID внутреннего сервиса WB
• status number — HTTP статус-код
• statusText string — Расшифровка HTTP статус-кода
• timestamp string — Дата и время запроса

Структура 402:

• title string — Заголовок ошибки
• detail string — Детали ошибки. Ошибка возвращается только сервисам из Каталога решений для бизнеса

Структура 403:

• title string — Заголовок ошибки
• status integer<int64> — HTTP статус-код
• detail string — Детали ошибки
• requestId string — Уникальный ID запроса
• origin string — ID внутреннего сервиса WB

Структура 429:

• title string — Заголовок ошибки
• detail string — Детали ошибки
• code string — Внутренний код ошибки
• requestId string — Уникальный ID запроса
• origin string — ID внутреннего сервиса WB
• status number — HTTP статус-код
• statusText string — Расшифровка HTTP статус-кода
• timestamp string — Дата и время запроса

Примеры вызова

Аргументы показаны именами параметров — подставьте свои значения. Языки, в клиенте которых этой операции нет, не показаны.

Python

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

cfg = Configuration(access_token="<ваш JWT WB>")
api = ReportsApi(ApiClient(cfg))

result = api.get_v1_measurement_penalties(date_to=..., limit=..., date_from=..., offset=...)
print(result)

TypeScript

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

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

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

Go

import (
	"context"
	"fmt"

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

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

result, _, err := client.ReportsAPI.GetV1MeasurementPenalties(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("<ваш JWT WB>"));
ReportsApi api = new ReportsApi(client);

System.out.println(api.getV1MeasurementPenalties(dateTo, limit, dateFrom, 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('<ваш JWT WB>'));
$api = new ReportsApi(new Client(), $config);

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

OneScript

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

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

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

C#

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

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

Console.WriteLine(api.GetV1MeasurementPenalties(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("<ваш JWT WB>");

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