PHP Класс Yandex\Market\Partner\PartnerClient

Автор: Alexander Khaylo ([email protected])
Наследование: extends Yandex\Common\AbstractServiceClient
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$campaignId string Campaign Id
$clientId string Application id
$login string User login
$serviceDomain string API domain

Открытые методы

Метод Описание
__construct ( string $token = '' )
getAccessToken ( ) : string Get OAuth data for header request
getCampaignId ( ) : string
getCampaigns ( ) : Yandex\Market\Partner\Models\Campaigns Get User Campaigns
getClientId ( ) : string
getLogin ( ) : string
getOrder ( integer $orderId ) : Yandex\Market\Partner\Models\Order Get order info
getOrders ( array $params = [] ) : null | Yandex\Market\Partner\Models\Orders Get only orders data without pagination
getOrdersResponse ( array $params = [] ) : Yandex\Market\Partner\Models\GetOrdersResponse Get information about orders by campaign id
getServiceUrl ( string $resource = '' ) : string Get url to service resource with parameters
setCampaignId ( string $campaignId )
setClientId ( string $clientId )
setLogin ( string $login )
setOrderStatus ( integer $orderId, string $status, null | string $subStatus = null ) : Yandex\Market\Partner\Models\Order Send changed status to Yandex.Market
updateDelivery ( integer $orderId, Yandex\Market\Partner\Models\Delivery $delivery ) : Yandex\Market\Partner\Models\Order Update changed delivery parameters

Защищенные методы

Метод Описание
sendRequest ( string $method, string | Psr\Http\Message\UriInterface $uri, array $options = [] ) : Response Sends a request

Описание методов

__construct() публичный Метод

public __construct ( string $token = '' )
$token string access token

getAccessToken() публичный Метод

Get OAuth data for header request
См. также: http://api.yandex.ru/market/partner/doc/dg/concepts/authorization.xml
public getAccessToken ( ) : string
Результат string

getCampaignId() публичный Метод

public getCampaignId ( ) : string
Результат string

getCampaigns() публичный Метод

Returns the user to the list of campaigns Yandex.market. The list coincides with the list of campaigns that are displayed in the partner interface Yandex.Market on page "My shops."
См. также: http://api.yandex.ru/market/partner/doc/dg/reference/get-campaigns.xml
public getCampaigns ( ) : Yandex\Market\Partner\Models\Campaigns
Результат Yandex\Market\Partner\Models\Campaigns

getClientId() публичный Метод

public getClientId ( ) : string
Результат string

getLogin() публичный Метод

public getLogin ( ) : string
Результат string

getOrder() публичный Метод

Get order info
См. ссылку: http://api.yandex.ru/market/partner/doc/dg/reference/get-campaigns-id-orders-id.xml
public getOrder ( integer $orderId ) : Yandex\Market\Partner\Models\Order
$orderId integer
Результат Yandex\Market\Partner\Models\Order

getOrders() публичный Метод

Get only orders data without pagination
public getOrders ( array $params = [] ) : null | Yandex\Market\Partner\Models\Orders
$params array
Результат null | Yandex\Market\Partner\Models\Orders

getOrdersResponse() публичный Метод

Get information about orders by campaign id
См. также: http://api.yandex.ru/market/partner/doc/dg/reference/get-campaigns-id-orders.xml
public getOrdersResponse ( array $params = [] ) : Yandex\Market\Partner\Models\GetOrdersResponse
$params array Returns information on the requested orders. Available filtering by date ordering and order status. The maximum range of dates in a single request for a resource - 30 days.
Результат Yandex\Market\Partner\Models\GetOrdersResponse

getServiceUrl() публичный Метод

Get url to service resource with parameters
См. также: http://api.yandex.ru/market/partner/doc/dg/concepts/method-call.xml
public getServiceUrl ( string $resource = '' ) : string
$resource string
Результат string

sendRequest() защищенный Метод

Sends a request
protected sendRequest ( string $method, string | Psr\Http\Message\UriInterface $uri, array $options = [] ) : Response
$method string HTTP method
$uri string | Psr\Http\Message\UriInterface URI object or string.
$options array Request options to apply.
Результат GuzzleHttp\Psr7\Response

setCampaignId() публичный Метод

public setCampaignId ( string $campaignId )
$campaignId string

setClientId() публичный Метод

public setClientId ( string $clientId )
$clientId string

setLogin() публичный Метод

public setLogin ( string $login )
$login string

setOrderStatus() публичный Метод

Send changed status to Yandex.Market
См. ссылку: http://api.yandex.ru/market/partner/doc/dg/reference/put-campaigns-id-orders-id-status.xml
public setOrderStatus ( integer $orderId, string $status, null | string $subStatus = null ) : Yandex\Market\Partner\Models\Order
$orderId integer
$status string
$subStatus null | string
Результат Yandex\Market\Partner\Models\Order

updateDelivery() публичный Метод

Update changed delivery parameters
См. ссылку: http://api.yandex.ru/market/partner/doc/dg/reference/put-campaigns-id-orders-id-delivery.xml
public updateDelivery ( integer $orderId, Yandex\Market\Partner\Models\Delivery $delivery ) : Yandex\Market\Partner\Models\Order
$orderId integer
$delivery Yandex\Market\Partner\Models\Delivery
Результат Yandex\Market\Partner\Models\Order Example: PUT /v2/campaigns/10003/order/12345/delivery.json HTTP/1.1

Описание свойств

$campaignId защищенное свойство

Campaign Id
protected string $campaignId
Результат string

$clientId защищенное свойство

Application id
protected string $clientId
Результат string

$login защищенное свойство

User login
protected string $login
Результат string

$serviceDomain защищенное свойство

API domain
protected string $serviceDomain
Результат string