Перейти к содержанию

Получить купленные ключи

GET /api/v1/keys-api/keys/redeemed

Метод позволяет получить список купленных ключей с использованием фильтрации.

Описание параметров фильтрации

  • offer_id — Фильтрация по ID предложения. Позволяет выбрать ключи, связанные с определенным предложением.
  • skip — Смещение. Указывает, сколько записей нужно пропустить в результирующем наборе.
    Например, если skip равно 20, то выборка начнется с 21 записи.
  • take — Количество записей для получения. Указывает, сколько ключей должно быть возвращено в ответе.
    Например, если take равно 10, то в ответе будет не более 10 записей.
  • date_from — Фильтрация по дате покупки начиная с указанной даты (включительно).
    Формат даты: RFC3339.
  • date_to — Фильтрация по дате покупки до указанной даты (не включительно).
    Формат даты: RFC3339.

Максимум 100 запросов в секунду

Параметры

Имя Расположение Тип Обязательный Описание
offer_id query integer нет Фильтрация по ID предложения. Позволяет выбрать ключи, связанные с определенным предложением
skip query integer нет Смещение. Указывает, сколько записей нужно пропустить в результирующем наборе. Используется для пагинации
take query integer нет Количество записей для получения. Указывает, сколько ключей должно быть возвращено в ответе
date_from query string нет Фильтрация по дате покупки начиная с указанной даты (включительно).

Формат даты: RFC3339 (2023-06-17T19:20:30Z)
date_to query string нет Фильтрация по дате покупки до указанной даты (не включительно). Формат даты: RFC3339 (2024-10-18T19:20:30Z)

Ответ: KeysRedeemedResponseList

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

import os
from wildberries_sdk import wbd

token = os.getenv("WB_API_TOKEN")
api = wbd.DefaultApi(
    wbd.ApiClient(wbd.Configuration(api_key={"HeaderApiKey": token}))
)
result = api.get_redeemed_keys()
print(result)

import { Configuration, DefaultApi } from 'wildberries-sdk';

const api = new DefaultApi(new Configuration({ apiKey: process.env.WB_API_TOKEN }));
const result = await api.getRedeemedKeys();
console.log(result);

cfg := wbd.NewConfiguration()
cfg.AddDefaultHeader("Authorization", os.Getenv("WB_API_TOKEN"))
client := wbd.NewAPIClient(cfg)
result, _, err := client.DefaultApi.GetRedeemedKeys(context.Background()).Execute()

<?php
$config = Wildberries\Sdk\Wbd\Configuration::getDefaultConfiguration()
    ->setApiKey('Authorization', getenv('WB_API_TOKEN'));
$api = new Wildberries\Sdk\Wbd\Api\DefaultApi(new GuzzleHttp\Client(), $config);
$result = $api->getRedeemedKeys();

use wildberries_sdk_wbd::apis::{configuration::Configuration, configuration::ApiKey, default_api};

let mut config = Configuration::new();
config.api_key = Some(ApiKey { prefix: None, key: std::env::var("WB_API_TOKEN").unwrap() });
let result = default_api::get_redeemed_keys(&config).await?;