PHP 클래스 Yandex\Market\Partner\PartnerClient

저자: Alexander Khaylo ([email protected])

상속: extends Yandex\Common\AbstractServiceClient

파일 보기 프로젝트 열기: nixsolutions/yandex-php-library 1 사용 예제들

보호된 프로퍼티들

프로퍼티	타입	설명
$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