Tariffs.php

<?php

declare(strict_types=1);

namespace Dakword\WBSeller\API\Endpoint;

use Dakword\WBSeller\API\AbstractEndpoint;
use DateTime;

class Tariffs extends AbstractEndpoint
{

    /**
     * Комиссия по категориям товаров
     *
     * Комиссия WB по родительским категориям товаров согласно модели продаж.
     *
     * Максимум - 1 запрос в минуту.
     * @see https://openapi.wb.ru/tariffs/api/ru/#tag/Komissii/paths/~1api~1v1~1tariffs~1commission/get
     *
     * @return object Список комиссий
     */
    public function commission(): object
    {
        return $this->getRequest('/api/v1/tariffs/commission', [
            'locale' => $this->locale()
        ])
        ->report;
    }

    /**
     * Тарифы для коробов
     *
     * Для товаров, которые поставляются на склад в коробах (коробках), возвращает стоимость:
     *  - доставки со склада или пункта приёма до покупателя;
     *  - доставки от покупателя до пункта приёма;
     *  - хранения на складе Wildberries.
     *
     * Максимум — 60 запросов в минуту.
     * @see https://openapi.wb.ru/tariffs/api/ru/#tag/Koefficienty-skladov/paths/~1api~1v1~1tariffs~1box/get
     *
     * @param DateTime $date Дата
     *
     * @return object {dtFromMin: string, dtNextBox: string, dtTillMax: string, warehouseList: array}
     */
    public function box(DateTime $date): object
    {
        return $this->getRequest('/api/v1/tariffs/box', [
            'date' => $date->format('Y-m-d'),
        ])
        ->response->data;
    }

    /**
     * Тарифы для монопалет
     *
     * Для товаров, которые поставляются на склад Wildberries на монопалетах, возвращает стоимость:
     *  - доставки со склада до покупателя;
     *  - доставки от покупателя до склада;
     *  - хранения на складе Wildberries.
     *
     * Максимум — 60 запросов в минуту.
     * @see https://openapi.wb.ru/tariffs/api/ru/#tag/Koefficienty-skladov/paths/~1api~1v1~1tariffs~1pallet/get
     *
     * @param DateTime $date Дата
     *
     * @return object {dtFromMin: string, dtNextPallet: string, dtTillMax: string, warehouseList: array}
     */
    public function pallet(DateTime $date): object
    {
        return $this->getRequest('/api/v1/tariffs/pallet', [
            'date' => $date->format('Y-m-d'),
        ])
        ->response->data;
    }

    /**
     * Тарифы на возврат
     *
     * Возвращает тарифы:
     *  - на перевозку товаров со склада Wildberries или из пункта приёма до продавца;
     *  - на обратную перевозку возвратов, которые не забрал продавец.
     *
     * Максимум — 60 запросов в минуту.
     * @see https://openapi.wb.ru/tariffs/api/ru/#tag/Stoimost-vozvrata-prodavcu/paths/~1api~1v1~1tariffs~1return/get
     *
     * @param DateTime $date Дата
     *
     * @return object {dtNextDeliveryDumpKgt: string, dtNextDeliveryDumpSrg: string, dtNextDeliveryDumpSup: string, warehouseList: array}
     */
    public function return(DateTime $date): object
    {
        return $this->getRequest('/api/v1/tariffs/return', [
            'date' => $date->format('Y-m-d'),
        ])
        ->response->data;
    }

}