Delivery

Extends \Dumkaaa\Boxberry\Api\Common\AbstractDelivery

Базовый класс достаки

package

Default

Methods

Создает объект доставки

__construct(\Dumkaaa\Boxberry\Api\Common\Http\Client|null $httpClient = null, \Symfony\Component\HttpFoundation\Request|null $httpRequest = null) 
inherited

Arguments

$httpRequest

\Symfony\Component\HttpFoundation\Request|null

Метод позволяет рассчитать стоимость доставки ПиП.

calculate(array $options) : \Dumkaaa\Boxberry\Api\C2C\Message\Request\CalculationLapRequest

$options = [ 'sender_city' string (Required) Код города отправителя 'receiver_city' string (Required) Код города получателя 'public_price' int (Required) Объявленная стоимость в копейках 'promo_code' string (Optional) Промо код на скидку 'package' array|Package (Required) Данные об упаковке 'list_services' string[] (Optional) Массив данных кодов дополнительных услуг ]

Arguments

$options

array

Входные параметры (см. выше)

Response

\Dumkaaa\Boxberry\Api\C2C\Message\Request\CalculationLapRequest

Метод, позволяющий создать новый заказ.

createOrder(array $options) : \Dumkaaa\Boxberry\Api\C2C\Message\Request\NewOrderRequest

$options = [ 'delivery_type' int (Required) Тип доставки, возможные значения: • 1, если доставка от двери до двери; • 2, если доставка от двери до отделения; • 3, если доставка от отделения до двери; • 4, если доставка от отделения до отделения. 'public_price' int (Required) Объявленная стоимость в копейках 'payer_type' int (Required) Плательщик: • 1, если отправитель; • 2, если получатель; 'prepayd_sum' int (Optional) Предоплаченная сумма в копейках 'sender' array|Sender (Required) Информация об отправителе 'receiver' array|Receiver (Required) Данные о получателе 'package' array (Required) Упаковка 'promo_code' string (Optional) Промокод 'list_services' string[] (Optional) Массив данных кодов дополнительных услуг 'safe_deal' array|SafeDeal (Optional) Данные о безопасной сделке ]

Arguments

$options

array

Входные параметры (см. выше)

Response

\Dumkaaa\Boxberry\Api\C2C\Message\Request\NewOrderRequest

createRequest

createRequest(string $class, array $parameters) : \Dumkaaa\Boxberry\Api\Common\Message\Request\AbstractRequest
inherited
see \Dumkaaa\Boxberry\Api\Common\AbstractResponse

Arguments

$class

string

$parameters

array

Response

\Dumkaaa\Boxberry\Api\Common\Message\Request\AbstractRequest

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

deleteParcels(array $options) : \Dumkaaa\Boxberry\Api\C2C\Message\Request\DeleteParcelsRequest

$options = [ 'parcels' string[] (Required) Номера ЭН ]

Arguments

$options

array

Входные параметры (см. выше)

Response

\Dumkaaa\Boxberry\Api\C2C\Message\Request\DeleteParcelsRequest

Метод, возвращает список возможных типов вложений.

getAttachmentTypes(array $options = array()) : \Dumkaaa\Boxberry\Api\C2C\Message\Request\ListAttachmentTypesRequest

$options = [ ]

Arguments

$options

array

Входные параметры (см. выше)

Response

\Dumkaaa\Boxberry\Api\C2C\Message\Request\ListAttachmentTypesRequest

Метод позволяет получить список городов, в которых есть пункты выдачи заказов Boxberry.

getCities(array $options = array()) : \Dumkaaa\Boxberry\Api\C2C\Message\Request\ListCitiesRequest

$options = [ 'lap_receive' bool (Optional) Доступен прием писем и посылок 'lap_take' bool (Optional) Доступна выдача писем и посылок 'cd_available' bool (Optional) Доступна курьерская доставка ]

Arguments

$options

array

Входные параметры (см. выше)

Response

\Dumkaaa\Boxberry\Api\C2C\Message\Request\ListCitiesRequest

getDefaultHttpClient

getDefaultHttpClient() : \Dumkaaa\Boxberry\Api\Common\Http\Client
inherited

getDefaultHttpRequest

getDefaultHttpRequest() : \Symfony\Component\HttpFoundation\Request
inherited

Response

\Symfony\Component\HttpFoundation\Request

Возвращает параметры по умолчанию для сервиса в формате: array( 'token' => '', 'endPoint' => '', );

getDefaultParameters() : array
inherited
inheritdoc

Response

array

getName

getName() 

Метод для получения списка доступных упаковок.

getPackages(array $options = array()) : \Dumkaaa\Boxberry\Api\C2C\Message\Request\ListPackagesRequest

$options = [ ]

Arguments

$options

array

Входные параметры (см. выше)

Response

\Dumkaaa\Boxberry\Api\C2C\Message\Request\ListPackagesRequest

getParameter

getParameter(string $key) : mixed
inherited

Arguments

$key

string

Response

mixed

Возвращает все параметры сервиса

getParameters() : array
inherited

Response

array

Метод, позволяющий получить список ПВЗ.

getPoints(array $options = array()) : \Dumkaaa\Boxberry\Api\C2C\Message\Request\ListPointsRequest

$options = [ 'payment' bool (Optional) Только с возможностью приема оплаты 'city' string (Optional) Код города в ИС Boxberry ]

Arguments

$options

array

Входные параметры (см. выше)

Response

\Dumkaaa\Boxberry\Api\C2C\Message\Request\ListPointsRequest

Метод для получения списка дополнительных услуг.

getServices(array $options = array()) : \Dumkaaa\Boxberry\Api\C2C\Message\Request\ListServicesRequest

$options = [ ]

Arguments

$options

array

Входные параметры (см. выше)

Response

\Dumkaaa\Boxberry\Api\C2C\Message\Request\ListServicesRequest

Возвращает короткое имя класса используемого сервиса

getShortName() : string
inherited
inheritdoc

Response

string

Метод, позволяющий получить статусы отправления по номеру отслеживания.

getStatuses(array $options) : \Dumkaaa\Boxberry\Api\C2C\Message\Request\ListStatusesRequest

$options = [ 'tracking' string (Required) Номер ЭН ]

Arguments

$options

array

Входные параметры (см. выше)

Response

\Dumkaaa\Boxberry\Api\C2C\Message\Request\ListStatusesRequest

Метод позволяет получить список почтовых индексов, для которых возможна курьерская доставка.

getZips(array $options = array()) : \Dumkaaa\Boxberry\Api\C2C\Message\Request\ListZipsRequest

$options = [ ]

Arguments

$options

array

Входные параметры (см. выше)

Response

\Dumkaaa\Boxberry\Api\C2C\Message\Request\ListZipsRequest

Заполняет сервис переданными параметрами

initialize(array $parameters = array()) : $this
inherited

$parameters = [ 'api_token' string (Required) Ключ доступа 'endPoint' string (Required) Урл api ]

inheritdoc

Arguments

$parameters

array

Входные параметры (см. выше)

Response

$this

setEndPoint

setEndPoint( $token) 

Arguments

$token

setParameter

setParameter(string $key, mixed $value) : $this
inherited

Arguments

$key

string

$value

mixed

Response

$this

setToken

setToken( $token) 

Arguments

$token

Properties

Параметры достаки

parameters : \Symfony\Component\HttpFoundation\ParameterBag
inherited
var

Type(s)

\Symfony\Component\HttpFoundation\ParameterBag

PSR-7 Http клиент

httpClient : \Dumkaaa\Boxberry\Api\Common\Http\Client
inherited

Объект запроса

httpRequest : \Symfony\Component\HttpFoundation\Request
inherited
var

Type(s)

\Symfony\Component\HttpFoundation\Request