Laravel NovaPoshta

https://github.com/daaner/novaposhta
Admin
Laravel NovaPoshta is a comprehensive Laravel package for managing shipments and accessing the...
Tokens:76,200
Snippets:448
Trust Score:7.6
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install daaner/novaposhta via Composer

Source: https://github.com/daaner/novaposhta/blob/master/docs/README.md

Install the package via Composer. Requires Laravel 7+ and PHP >= 7.2.5.

```bash
composer require daaner/novaposhta
```

--------------------------------

### Get Return Reasons

Source: https://github.com/daaner/novaposhta/blob/master/docs/AdditionalService.md

Retrieves the list of return reasons.

```php
$np = new AdditionalService;

$addition = $np->getReturnReasons();

dd($addition);
```

--------------------------------

### Get Return Reasons Subtypes

Source: https://github.com/daaner/novaposhta/blob/master/docs/AdditionalService.md

Retrieves the list of return reason subtypes. Optionally pass a Ref to get subtypes for a specific reason.

```php
$np = new AdditionalService;

$addition = $np->getReturnReasonsSubtypes();
//либо, если другие причины (в конфиге значение по умолчанию), можно передать Ref
$addition = $np->getReturnReasonsSubtypes($ref);

dd($addition);
```

--------------------------------

### Get Return Orders List

Source: https://github.com/daaner/novaposhta/blob/master/docs/AdditionalService.md

Retrieves the list of return orders. Optional parameters: setLimit, setPage, setDateBegin, setDateEnd.

```php
$np = new AdditionalService;

//НЕОБЯЗАТЕЛЬНЫЕ параметры
$np->setLimit(10);
$np->setPage(1);
$serv->setDateBegin('dd.mm.yyyy');
$serv->setDateEnd('dd.mm.yyyy');

$addition = $np->getReturnOrdersList();

dd($addition);
```

--------------------------------

### getServiceTypes() - get delivery technologies

Source: https://github.com/daaner/novaposhta/blob/master/docs/Common.md

Retrieves the delivery technologies reference. Localization is not supported by Nova Poshta.

```php
$c = new Common;
//локализация справочника не поддерживается Новой Почтой
$list = $c->getServiceTypes();

dd($list);
```

--------------------------------

### Get standard cards list

Source: https://github.com/daaner/novaposhta/blob/master/docs/LoyaltyUser.md

Retrieves a list of data on the counterparty's bonus program. Optional parameters setLimit and setPage can be used for pagination. Requires a CounterpartyRef identifier.

```php
$np = new LoyaltyUser;
$np->setAPI('3e6****367****bdba****2d87****da');

//НЕОБЯЗАТЕЛЬНЫЕ параметры
$np->setLimit(10);
$np->setPage(2);

$CounterpartyRef = '00000000-0000-0000-0000-000000000000';
$loyalty = $np->getStandartCardsList($CounterpartyRef);

dd($loyalty);
```

--------------------------------

### Retrieve Wallet Management Data

Source: https://github.com/daaner/novaposhta/blob/master/docs/Payment.md

Example of initializing the Payment model, setting the API key, and calling the walletManagement method to retrieve payment card data.

```php
$np = new Payment;
$np->setAPI('3e6****367****bdba****2d87****da');
$check = $np->walletManagement();

dd($check);
```

--------------------------------

### getStreet() usage example

Source: https://github.com/daaner/novaposhta/blob/master/docs/Address.md

Creates an Address instance, sets limit and page, then calls getStreet() with a CityRef and optional street name prefix. The result is dumped with dd().

```php
$adr = new Address;

$adr->setLimit(2);
$adr->setPage(1);

$streets = $adr->getStreet('a9522a7e-eaf5-11e7-ba66-005056b2fc3d');
//или
$streets = $adr->getStreet('a9522a7e-eaf5-11e7-ba66-005056b2fc3d', 'ш');

dd($streets);
```

--------------------------------

### Get inventory nomenclatures list

Source: https://github.com/daaner/novaposhta/blob/master/docs/InventoryGeneral.md

Creates an InventoryGeneral instance, sets the API key, and retrieves the list of available material values. The result is dumped with dd().

```php
$np = new InventoryGeneral;
$np->setAPI('3e6****367****bdba****2d87****da');
$check = $np->getInventoryNomenclaturesList();

dd($check);
```

--------------------------------

### getOwnershipFormsList() - get ownership forms

Source: https://github.com/daaner/novaposhta/blob/master/docs/Common.md

Retrieves the ownership forms reference. Localization is not supported by Nova Poshta.

```php
$c = new Common;
//локализация справочника не поддерживается Новой Почтой
$list = $c->getOwnershipFormsList();

dd($list);
```

--------------------------------

### getSettlements() usage example

Source: https://github.com/daaner/novaposhta/blob/master/docs/Address.md

Creates an Address instance, sets page (limit is forced to 150 and setLimit is not applied), optionally applies filters by area, region, warehouse presence, or Ref, then calls getSettlements() with an optional search string. The result is dumped with dd().

```php
$adr = new Address;
//насильно работает ф-ция лимита в 150 (setLimit - НЕ применяется)

$adr->setPage(3);

// Можно использовать фильтры (не обязательные)
$adr->filterAreaRef('dcaadf02-4b33-11e4-ab6d-005056801329'); //по области
$adr->filterRegionRef('dcaadf02-4b33-11e4-ab6d-005056801329'); //по региону
$adr->filterWarehouse(); //по наличию отделений в населенном пункте
$adr->filterRef('e71abb60-4b33-11e4-ab6d-005056801329'); //по Ref населенного пункта

$settlements = $adr->getSettlements();
//или
$settlements = $adr->getSettlements('днепр');

dd($settlements);
```

--------------------------------

### getCargoDescriptionList() - get cargo descriptions with pagination and search

Source: https://github.com/daaner/novaposhta/blob/master/docs/Common.md

Retrieves cargo descriptions. Pagination works but limit and localization are not supported. Search by Russian and Ukrainian words is case-insensitive.

```php
$c = new Common;
//работает пагинация, но не поддерживается лимит и локализация
$c->setPage(2);
$list = $c->getCargoDescriptionList();

//можно использовать поиск по русским и украинским словам (регистр не важен)
$list = $c->getCargoDescriptionList('Од');

dd($list);
```

--------------------------------

### getTiresWheelsList() - get tires and wheels

Source: https://github.com/daaner/novaposhta/blob/master/docs/Common.md

Retrieves the tires and wheels reference. Limit, pagination, and localization are not supported.

```php
$c = new Common;
//не поддерживается лимит, пагинация и локализация
$list = $c->getTiresWheelsList();

dd($list);
```

--------------------------------

### Get inventory orders list

Source: https://github.com/daaner/novaposhta/blob/master/docs/InventoryGeneral.md

Creates an InventoryGeneral instance, sets the API key, optionally sets limit and page, and retrieves the list of ordered material values. Can pass a counterparty ref as an argument. The result is dumped with dd().

```php
$np = new InventoryGeneral;
$np->setAPI('3e6****367****bdba****2d87****da');

//НЕОБЯЗАТЕЛЬНЫЕ параметры
$np->setLimit(10);
$np->setPage(2);

$check = $np->getInventoryOrdersList();

//либо
$check = $np->getInventoryOrdersList('ref контрагента');


dd($check);
```

--------------------------------

### Custom API request with getResponse

Source: https://github.com/daaner/novaposhta/blob/master/README.md

Sends a custom request to the Nova Poshta API using getResponse, useful when new methods are added. The example uses the TrackingDocument model and getStatusDocuments method, with $auth set to true.

```php
use NovaPoshta;
$model = 'TrackingDocument'; //нужная модель
$calledMethod = 'getStatusDocuments'; //нужный метод
$methodProperties = [
  //данные по документации
];
$np = new NovaPoshta;
$data = $np->getResponse($model, $calledMethod, $methodProperties, $auth = true);

dd($data);
```

--------------------------------

### Get loyalty info by API key

Source: https://github.com/daaner/novaposhta/blob/master/docs/LoyaltyUser.md

Retrieves the user's bonus card balance, card number, and other data using the getLoyaltyInfoByApiKey method. Requires setting the API key via setAPI.

```php
$np = new LoyaltyUser;
$np->setAPI('3e6****367****bdba****2d87****da');
$loyalty = $np->getLoyaltyInfoByApiKey();

dd($loyalty);
```

--------------------------------

### getPackList() - get packaging types with filters

Source: https://github.com/daaner/novaposhta/blob/master/docs/Common.md

Retrieves the packaging types reference. Limit, pagination, and localization are not supported. Optional filters select values greater than or equal to the specified ones; volumetric weight filter is undocumented but works. TypeOfPacking is no longer used in the API.

```php
$c = new Common;
//не поддерживается лимит, пагинация и локализация

//работают необязательные фильтры, выбирается значение больше или равно указанного
$c->setLength(3); // либо $c->setLength('12.0');
$c->setWidth(3);
$c->setHeight(3);
//не документирован, но тоже работает фильтр по объемному весу
$c->setVolumetricWeight(15);

//TypeOfPacking уже не используется в АПИ и не добавлен
$list = $c->getPackList();

dd($list);
```

--------------------------------

### Get car orders list with getOrdersList()

Source: https://github.com/daaner/novaposhta/blob/master/docs/CarCallGeneral.md

Create a CarCallGeneral instance, set the API key, and call getOrdersList() to retrieve a list of car orders. Passing false to getOrdersList() returns short information. The result is dumped with dd().

```php
$np = new CarCallGeneral;
$np->setAPI('3e6****367****bdba****2d87****da');

$check = $np->getOrdersList();
// либо короткая информация
$check = $np->getOrdersList(false);

dd($check);
```

--------------------------------

### Get loyalty card turnover by API key

Source: https://github.com/daaner/novaposhta/blob/master/docs/LoyaltyUser.md

Fetches bonus accrual and write-off data. Without parameters returns current month data; with year and month returns specific period. If only year is provided, shows last (or current) month of that year.

```php
$np = new LoyaltyUser;
$np->setAPI('3e6****367****bdba****2d87****da');

// Без указания года и месяца выведет данные о текущем месяце
$loyalty = $np->getLoyaltyCardTurnoverByApiKey();

// С указанием года и месяца
// Если указать год, а месяц опустить - отображает последний (либо текущий) месяц года
$loyalty = $np->getLoyaltyCardTurnoverByApiKey(2022, 11);

dd($loyalty);
```

--------------------------------

### getStatusDocuments() - get full TTN info

Source: https://github.com/daaner/novaposhta/blob/master/docs/TrackingDocument.md

Shows how to call getStatusDocuments() with various input formats: a single TTN string, comma-separated TTNs, an array of TTNs, an associative array with custom keys, or an array of arrays with DocumentNumber and Phone keys. The method returns full information about the waybills.

```php
$doc = '20450296339688';
// либо
$doc = '20450296339688, 20450296339742';
//либо
$doc = ['20450296339688, 20450296339742'];
//либо
$doc = [
    0 => '20450296339688',
    '100500' => '20450296339742'
];
//либо в массиве одна или несколько ТТН с отдельными телефонами
$doc = array();
array_push($doc, ['DocumentNumber' => 'ttn1', 'Phone' => 'phone1']);
array_push($doc, ['DocumentNumber' => 'ttn2', 'Phone' => 'phone2']);

$np = new TrackingDocument;
$getStatusDocuments = $np->getStatusDocuments($doc);

dd($getStatusDocuments);
```

--------------------------------

### Publish config and localization files

Source: https://github.com/daaner/novaposhta/blob/master/docs/README.md

Publish the configuration and localization files using the NovaPoshtaServiceProvider.

```bash
php artisan vendor:publish --provider="Daaner\NovaPoshta\NovaPoshtaServiceProvider"
```

--------------------------------

### getCounterpartyOptions() - load counterparty options by Ref

Source: https://github.com/daaner/novaposhta/blob/master/docs/Counterparty.md

Loads counterparty options by Ref.

```php
$cp = new Counterparty;

$agent = $cp->getCounterpartyOptions("16b39437-c037-11ea-8513-b88303659df5");

dd($agent);
```

--------------------------------

### CheckPossibilityTermExtension() - Check storage extension

Source: https://github.com/daaner/novaposhta/blob/master/docs/AdditionalService.md

Checks if storage extension is possible. Not documented; empirically the service is unavailable for legal entities with auto-return enabled.

```php
$np = new AdditionalService;
$np->setApi('...');
$ttn = '20450600000001';
$term = $np->CheckPossibilityTermExtension($ttn);

dd($term);
```

--------------------------------

### Import LoyaltyUser model

Source: https://github.com/daaner/novaposhta/blob/master/docs/LoyaltyUser.md

Import the LoyaltyUser model class from the Daaner NovaPoshta package.

```php
use Daaner\NovaPoshta\Models\LoyaltyUser;
```

--------------------------------

### getTypesOfCounterparties() - get counterparty types

Source: https://github.com/daaner/novaposhta/blob/master/docs/Common.md

Retrieves the counterparty types reference. Localization is not supported by Nova Poshta.

```php
$c = new Common;
//локализация справочника не поддерживается Новой Почтой
$list = $c->getTypesOfCounterparties();

dd($list);
```

--------------------------------

### getPaymentForms() - get payment forms

Source: https://github.com/daaner/novaposhta/blob/master/docs/Common.md

Retrieves the payment forms reference. Localization is not supported by Nova Poshta.

```php
$c = new Common;
//локализация справочника не поддерживается Новой Почтой
$list = $c->getPaymentForms();

dd($list);
```

--------------------------------

### save() - create counterparty (PrivatePerson, Organization, ThirdPerson)

Source: https://github.com/daaner/novaposhta/blob/master/docs/Counterparty.md

Creates a counterparty with three possible types: PrivatePerson (requires firstName, lastName, phone), Organization (requires OwnershipForm and FirstName; other fields ignored), and ThirdPerson (requires EDRPOU; setting EDRPOU forces ThirdPerson property).

```php
$cp = new Counterparty;

//Для создания физического лица (PrivatePerson) обязательные параметры:
//$firstName, $lastName, $phone.
//Параметры $middleName и $email - опциональные

//Тип контрагента
$cp->setCounterpartyType('PrivatePerson');
//либо
$cp->setCounterpartyType('Organization');

//Свойства контрагента
$cp->setCounterpartyProperty('Recipient');
//либо
$cp->setCounterpartyProperty('Sender');

//PrivatePerson
//$firstName, $lastName = null, $middleName = null, $phone = null, $email = null
$agent = $cp->save("Иван", "Иванов", "Иванович", "380675554433", "ivanov@gmail.com");

//Для создания контрагента с юридическим лицом обязательно указать OwnershipForm
//CounterpartyType установится насильно и этот параметр указывать необязательно
//обязательные параметры OwnershipForm и FirstName,
//а параметры MiddleName, LastName, Email и Phone - игнорируются

//Organization
$cp->setCounterpartyProperty('Recipient');
$cp->setOwnershipForm('7f0f351d-2519-11df-be9a-000c291af1b3');
$agent = $cp->save("ФірмаТурбо");

//ThirdPerson обязательно указание EDRPOU
// $cp->setCounterpartyProperty('ThirdPerson'); // не обязательно указывать
$cp->setEDRPOU('99999999');
$agent = $cp->save("Тут неважно какой текст");

//при указании setEDRPOU($number) насильно ставится setCounterpartyProperty('ThirdPerson')

dd($agent);
```

--------------------------------

### getCities() - Retrieve cities with pagination, search, and ref

Source: https://github.com/daaner/novaposhta/blob/master/docs/Address.md

Demonstrates three ways to use getCities(): with pagination (setLimit, setPage), by name, and by reference code with the second parameter set to false.

```php
//получить все города используя пагинацию
$adr = new Address;
$adr->setLimit(100);
$adr->setPage(3);
$cities = $adr->getCities();

dd($cities);

//Можно искать по имени. Опять же можно использовать пагинацию, но списки не большие, поэтому можно и без нее
$adr = new Address;
$cities = $adr->getCities('Днепр');

dd($cities);

//Можно получить данные по реф коду, указав вторым параметром `false`
$adr = new Address;
$city = $adr->getCities('ed5ca607-b33f-11e3-9fa0-0050568002cf', false);

dd($city);
```

--------------------------------

### getWarehouses() - Retrieve warehouses with optional filters

Source: https://github.com/daaner/novaposhta/blob/master/docs/Address.md

Shows how to retrieve warehouses with optional filters (filterBicycleParking, filterPostFinance, setTypeOfWarehouseRef, setLimit) and three ways to call getWarehouses(): all, by city name, or by CityRef with the second parameter false.

```php
$adr = new Address;

//необязательные фильтры применяются
$adr->filterBicycleParking();
$adr->filterPostFinance();
$adr->setTypeOfWarehouseRef('9a68df70-0267-42a8-bb5c-37f427e36ee4');
$adr->setLimit(8);

//получить все (используйте лимит и пагинацию, данных много)
$warehouses = $adr->getWarehouses();
//или
$warehouses = $adr->getWarehouses('Тернополь');
//или по "CityRef"
$warehouses = $adr->getWarehouses('db5c8904-391c-11dd-90d9-001a92567626', false);


dd($warehouses);
```

--------------------------------

### getScanSheetDocuments()

Source: https://github.com/daaner/novaposhta/blob/master/docs/ScanSheet.md

Gets a short list of waybills (TTN) of a scan sheet (registry). Requires an API key. Officially not documented.

```APIDOC
## getScanSheetDocuments()

### Description
Gets a short list of waybills (TTN) of a scan sheet (registry). Requires an API key. Officially not documented.

### Method
GET

### Endpoint
NovaPoshta API - ScanSheet model, getScanSheetDocuments method

### Parameters
#### Path Parameters
- **$ref** (string) - Required - Reference of the scan sheet.

#### Query Parameters
- **setLimit** (int) - Optional - Limit the number of results.
- **setPage** (int) - Optional - Page number for pagination.

### Request Example
```php
$np = new ScanSheet;
$np->setLimit(5); // Optional
$np->setPage(2);  // Optional
$ref = 'd1****54-****-****-****-b8830****df5';
$scansheet = $np->getScanSheetDocuments($ref);
```

### Response
Returns a short list of waybills.

### Response Example
```php
dd($scansheet);
```
```

--------------------------------

### Import Counterparty model

Source: https://github.com/daaner/novaposhta/blob/master/docs/Counterparty.md

Import the Counterparty model class for use in your PHP project.

```php
use Daaner\NovaPoshta\Models\Counterparty;
```

--------------------------------

### getMessageCodeText() - Get error codes

Source: https://github.com/daaner/novaposhta/blob/master/docs/CommonGeneral.md

Retrieves the error code reference list from Nova Poshta API and dumps the result.

```php
$cg = new CommonGeneral;
$lg = $cg->getMessageCodeText();

dd($lg);
```

--------------------------------

### Update to dev-master version

Source: https://github.com/daaner/novaposhta/blob/master/docs/README.md

Add the dev-master version to composer.json and run composer update to get the latest unreleased version.

```bash
"daaner/novaposhta": "dev-master"
# и выполните
composer update daaner/novaposhta
```

--------------------------------

### getStandartCardsList($CounterpartyRef)

Source: https://github.com/daaner/novaposhta/blob/master/docs/LoyaltyUser.md

Returns a list of data about the counterparty's bonus program. Optional parameters setLimit() and setPage() can be used.

```APIDOC
## getStandartCardsList($CounterpartyRef)

### Description
Returns a list of data about the counterparty's bonus program.

### Method
LoyaltyUser::getStandartCardsList($CounterpartyRef)

### Parameters
- **$CounterpartyRef** (string) - Required - Counterparty reference identifier.

### Optional Parameters (via setter methods)
- **setLimit(int)** - Optional - Limit the number of results.
- **setPage(int)** - Optional - Page number for pagination.

### Request Example
php
$np = new LoyaltyUser;
$np->setAPI('3e6****367****bdba****2d87****da');

// Optional parameters
$np->setLimit(10);
$np->setPage(2);

$CounterpartyRef = '00000000-0000-0000-0000-000000000000';
$loyalty = $np->getStandartCardsList($CounterpartyRef);


### Response
Returns list of bonus program data for the counterparty.
```

--------------------------------

### Register service provider in config/app.php

Source: https://github.com/daaner/novaposhta/blob/master/README.md

Add the service provider to the providers array in config/app.php if not using auto-discovery.

```php
Daaner\NovaPoshta\NovaPoshtaServiceProvider::class,
```

--------------------------------

### getScanSheet() - get scan sheet by Ref

Source: https://github.com/daaner/novaposhta/blob/master/docs/ScanSheet.md

Fetches information for a single scan sheet by its reference (Ref). Requires an API key.

```php
$np = new ScanSheet;
$ref = 'd1****54-****-****-****-b8830****df5';
$scansheet = $np->getScanSheet($ref);

dd($scansheet);
```

--------------------------------

### getPackList()

Source: https://github.com/daaner/novaposhta/blob/master/docs/Common.md

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

```APIDOC
## getPackList()

### Description
Получение справочника видов упаковки. Не поддерживается лимит, пагинация и локализация. Работают необязательные фильтры, выбирается значение больше или равно указанного.

### Method
GET

### Endpoint
Common/getPackList

### Parameters
#### Query Parameters
- **Length** (number) - Optional - Минимальная длина упаковки.
- **Width** (number) - Optional - Минимальная ширина упаковки.
- **Height** (number) - Optional - Минимальная высота упаковки.
- **VolumetricWeight** (number) - Optional - Минимальный объемный вес (не документирован, но работает).

### Request Example
```php
$c = new Common;
$c->setLength(3); // либо $c->setLength('12.0');
$c->setWidth(3);
$c->setHeight(3);
$c->setVolumetricWeight(15);
$list = $c->getPackList();
```

### Response
Справочник видов упаковки.

```

--------------------------------

### getCatalogCounterparty() - get counterparty by phone and last name

Source: https://github.com/daaner/novaposhta/blob/master/docs/Counterparty.md

Retrieves counterparty data (full name and more) by phone number and at least three characters of the last name.

```php
$cp = new Counterparty;

//обязателен телефон в формате и минимум три символа фамилии
$fullName = $cp->getCatalogCounterparty("0965775815", 'іва');

dd($fullName);
```

--------------------------------

### getScanSheetDocuments() - get documents of scan sheet

Source: https://github.com/daaner/novaposhta/blob/master/docs/ScanSheet.md

Retrieves a short list of waybills (TTN) for a scan sheet. Pagination can be controlled with setLimit() and setPage(). This method is not officially documented.

```php
$np = new ScanSheet;
$np->setLimit(5); // Необязательно
$np->setPage(2);  // Необязательно

$ref = 'd1****54-****-****-****-b8830****df5';
$scansheet = $np->getScanSheetDocuments($ref);

dd($scansheet);
```

--------------------------------

### getApiKeysList() - List API keys

Source: https://github.com/daaner/novaposhta/blob/master/docs/CommonGeneral.md

Fetches the list of available API keys for the account. Requires setting the API key via setAPI().

```php
$cg = new CommonGeneral;
$cg->setAPI('3e6****367****bdba****2d87****da');
$api = $cg->getApiKeysList();

dd($api);
```

--------------------------------

### getReturnReasons()

Source: https://github.com/daaner/novaposhta/blob/master/docs/AdditionalService.md

Retrieves the list of return reasons from the Nova Poshta API.

```APIDOC
## getReturnReasons()

### Description
Retrieves the list of return reasons.

### Method
getReturnReasons

### Parameters
None.

### Request Example
```php
$np = new AdditionalService;
$addition = $np->getReturnReasons();
```

### Response
Returns a list of return reasons.
```

--------------------------------

### Get promocode by phone

Source: https://github.com/daaner/novaposhta/blob/master/docs/LoyaltyUser.md

Retrieves active promocodes attached to a counterparty's phone. The method works only for PrivatePerson. Phone format can be +38067..., 38067..., or 067...

```php
$np = new LoyaltyUser;
$np->setAPI('3e6****367****bdba****2d87****da');

// Телефон контрагента в формате +38067..., 38067... либо 067...
$loyalty = $np->getPromocodeByPhone('+380671112233');

dd($loyalty);
```

--------------------------------

### saveRedirecting() - создание заявки на переадресацию посылки

Source: https://github.com/daaner/novaposhta/blob/master/docs/AdditionalService.md

Создает заявку на переадресацию посылки через метод saveRedirecting(), который является алиасом для save($ttn, 'orderRedirecting'). Отличия от save(): можно задать плательщика (setPayerType), заказчика (setCustomer), тип услуги (setServiceType) и изменить данные получателя (changeRecipientData). Параметры необязательны, значения по умолчанию берутся из конфига.

```php
$np = new AdditionalService;
$ttn = '206004560074695';
$np->setApi('...');

// на отделение не из списка отправителя (из справочника отделений)
$np->setRecipientWarehouse('137db83c-e6a9-11e5-899e-005056887b8d');

// либо на адрес отправителя (адрес для возврата, брать с ответа в методе CheckPossibilityCreateReturn)
$np->setReturnAddressRef('00000000-0000-0000-0000-000000000000');

// либо на новый адрес, указанный массивом
$newAddress = [
    'settlement' => '00000000-0000-0000-0000-000000000000', //Ref населенного пункта
    'street' => '00000000-0000-0000-0000-000000000000', //Ref улицы
    'building' => '4', //Номер дома
    'other' => '2', //Квартира или другое описание
];
$np->setRecipientSettlement($newAddress);

$np->setNote('Переадресация заказа'); //Заметка

//
/**
 * ========
 * Отличия от метода save()
 * ========
 */
// Установка плательщика за пересылку (по умолчанию из конфига)
// Учтите, что для оплаты пересылки отправителем - он должен иметь возможность автоматически списать оплату
$np->setPayerType('Recipient'); // необязательный параметр

//Заказчик переадресации (получателю не разрешается изменять данные получателя). По умолчанию `Sender`
$np->setCustomer('Recipient'); // необязательный параметр,

//Тип услуги (DoorsWarehouse, WarehouseWarehouse)
//Будьте осторожны при пересылке с адресной доставки, указывайте правильно
$np->setServiceType('WarehouseWarehouse'); //по умолчанию из конфига (service_type)

// Смена получателя. Игнорируется, если оформляет НЕ отправитель
$recipientData = [
    'Recipient' => '00000000-0000-0000-0000-000000000000', // можно НЕ указывать, если не знаете
    'RecipientContactName' => 'Іванов Іван Іванович',
    'RecipientPhone' => '380681111111',
];
$np->changeRecipientData($recipientData);


$addition = $np->saveRedirecting($ttn);
// либо же
$addition = $np->save($ttn, 'orderRedirecting');

dd($addition);
```

--------------------------------

### getMoneyTransferDocuments() - Get payment data

Source: https://github.com/daaner/novaposhta/blob/master/docs/InternetDocument.md

Retrieves payment data for a specified period. Optionally override API key with setAPI(), set pagination with setLimit() and setPage(), or pass a date range to the method.

```php
$intDoc = new InternetDocument;

//можно переопределить API, иначе возьмет данные с конфига
$intDoc->setAPI('c74***25'); //необязательно

$intDoc->setLimit(100); //необязательно
$intDoc->setPage(2);    //необязательно

$transfer = $intDoc->getMoneyTransferDocuments();

//либо можно указать диапазон
$from = '2021-01-01 00:00:00'; //Carbon, string, date, null
$from = '2021-02-01 00:00:00'; //Carbon, string, date, null
$transfer = $intDoc->getMoneyTransferDocuments($from, $to);

dd($transfer);
```

--------------------------------

### searchSettlements() - Search settlements

Source: https://github.com/daaner/novaposhta/blob/master/docs/Address.md

Shows how to search settlements using searchSettlements() with a limit. Note that setPage is not applied.

```php
$adr = new Address;
//работает ф-ция лимита, но можно и без нее, setPage - НЕ применяется
$adr->setLimit(20);

$settlements = $adr->searchSettlements('Дне');

dd($settlements);
```

--------------------------------

### getServiceTypes()

Source: https://github.com/daaner/novaposhta/blob/master/docs/Common.md

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

```APIDOC
## getServiceTypes()

### Description
Получение справочника технологий доставки. Локализация справочника не поддерживается Новой Почтой.

### Method
GET

### Endpoint
Common/getServiceTypes

### Parameters
Нет параметров.

### Request Example
```php
$c = new Common;
$list = $c->getServiceTypes();
```

### Response
Справочник технологий доставки.

```

--------------------------------

### getDocumentList() - Get list of all waybills

Source: https://github.com/daaner/novaposhta/blob/master/docs/InternetDocument.md

Retrieves a list of all express waybills. Optional parameters include limit, page, date filters, and flags to show full list, redelivery money, or unassembled cargo. The result is dumped with dd().

```php
$np = new InternetDocument;

// НЕ обязательные параметры
$np->setLimit(5);
$np->setPage(2);
//выборка по конкретной дате (выборка за период тогда не работает)
$np->setDateTime('10-05-2020');
//или выборка за период
$np->setDateTimeFrom('11-07-2020'); //Если не указано `setDateTimeFrom` - значение будет таким же, как `setDateTimeTo`
$np->setDateTimeTo('11-07-2020'); //Если не указано `setDateTimeTo` - значение будет сегодняшним числом
$np->showFullList(); // отобразить полный список (игнорируется лимит и постраничная разбивка)
$np->showRedeliveryMoney(); // Отобразить полный список ЭН с обратной доставкой. Требуется указание даты DateTimeFrom и DateTimeTo
$np->showUnassembledCargo(); // Отобразить полный список всех актуальных ЭН (по которым не написано заявление на возврат или утилизацию) не забранных получателями посылок. Требуется указание даты DateTimeFrom и DateTimeTo

$lists = $np->getDocumentList();

dd($lists);
```

--------------------------------

### createApiKey() - Create API key

Source: https://github.com/daaner/novaposhta/blob/master/docs/CommonGeneral.md

Creates a new API key. Optionally pass an organization Ref to personalize the key. Requires setting the API key via setAPI().

```php
$cg = new CommonGeneral;
$cg->setAPI('3e6****367****bdba****2d87****da');
$api = $cg->createApiKey();

//Для персонализации ключа, если у вас имеется Ref организации, можете его указать 
$api = $cg->createApiKey('005056887b8d-8478-11e5-c9ad-fa7dc024');

dd($api);
```

--------------------------------

### getCargoDescriptionList()

Source: https://github.com/daaner/novaposhta/blob/master/docs/Common.md

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

```APIDOC
## getCargoDescriptionList()

### Description
Получение справочника описаний груза. Работает пагинация, но не поддерживается лимит и локализация. Можно использовать поиск по русским и украинским словам (регистр не важен).

### Method
GET

### Endpoint
Common/getCargoDescriptionList

### Parameters
#### Query Parameters
- **find** (string) - Optional - Поиск по описанию груза.

### Request Example
```php
$c = new Common;
$c->setPage(2);
$list = $c->getCargoDescriptionList();

// с поиском
$list = $c->getCargoDescriptionList('Од');
```

### Response
Справочник описаний груза.

```

--------------------------------

### Import InventoryGeneral model

Source: https://github.com/daaner/novaposhta/blob/master/docs/InventoryGeneral.md

Import the InventoryGeneral model class from the Daaner NovaPoshta package.

```php
use Daaner\NovaPoshta\Models\InventoryGeneral;
```

--------------------------------

### save() - создание заявки на возврат посылки

Source: https://github.com/daaner/novaposhta/blob/master/docs/AdditionalService.md

Создает заявку на возврат посылки через метод save(). Можно указать отделение получателя, адрес отправителя или новый адрес массивом. Если ни один из этих параметров не задан, возврат оформляется на отделение из конфига `config('novaposhta.ref_return_warehouse')`. Необязательные поля: причина, подтип причины, заметка.

```php
$np = new AdditionalService;
$ttn = '206004560074695';
$np->setApi('...');

// на отделение не из списка отправителя (из справочника отделений)
$np->setRecipientWarehouse('137db83c-e6a9-11e5-899e-005056887b8d');

// либо на адрес отправителя (адрес для возврата, брать с ответа в методе CheckPossibilityCreateReturn)
$np->setReturnAddressRef('00000000-0000-0000-0000-000000000000');

// либо на новый адрес, указанный массивом
$newAddress = [
    'settlement' => '00000000-0000-0000-0000-000000000000', //Ref населенного пункта
    'street' => '00000000-0000-0000-0000-000000000000', //Ref улицы
    'building' => '4', //Номер дома
    'other' => '2', //Квартира или другое описание
];
$np->setRecipientSettlement($newAddress);

// ДОПОЛНИТЕЛЬНО! Добавлено для простоты оформления .
// Если не указан ни один пункт (ни setRecipientWarehouse, ни setReturnAddressRef, ни setRecipientSettlement),
// Возврат оформляется на отделение Ref которого берется из конфига `config('novaposhta.ref_return_warehouse')`

// НЕОБЯЗАТЕЛЬНЫЕ ПОЛЯ, отличные от значения в конфиге
$np->setReason('00000000-0000-0000-0000-000000000000'); //Ref причины из справочника
$np->setSubtypeReason('00000000-0000-0000-0000-000000000000'); //Ref подтипа причины из справочника
$np->setNote('Возврат заказа'); //Заметка возврата

$addition = $np->save($ttn);
// либо
$addition = $np->save($ttn, 'orderCargoReturn');

dd($addition);
```

--------------------------------

### searchSettlementStreets() - Search streets in settlements

Source: https://github.com/daaner/novaposhta/blob/master/docs/Address.md

Shows how to search streets in settlements using searchSettlementStreets() with a limit. Note that setPage is not applied.

```php
$adr = new Address;
//работает ф-ция лимита, но можно и без нее, setPage - НЕ применяется
$adr->setLimit(20);
$streets = $adr->searchSettlementStreets('e718a680-4b33-11e4-ab6d-005056801329', 'Шевченк');

dd($streets);
```

--------------------------------

### Import Payment Model

Source: https://github.com/daaner/novaposhta/blob/master/docs/Payment.md

The namespace import required to use the Payment model.

```php
use Daaner\NovaPoshta\Models\Payment;
```

--------------------------------

### save($description = null)

Source: https://github.com/daaner/novaposhta/blob/master/docs/InternetDocument.md

Метод модели InternetDocument для создания экспресс-накладной.

```APIDOC
## save($description = null)

### Description
Создание экспресс-накладной (ЭН).

### Method
Метод модели InternetDocument

### Parameters
#### Параметры метода
- `$description` (string|null) - Описание (название) посылки. Необязательный.

#### Необязательные методы-сеттеры
- `setAPI(string $apiKey)` - ключ API отправителя (для создания ЭН от другого отправителя)
- `setSender(array $sender)` - данные отправителя (массив с ключами: Sender, CitySender, SenderAddress, ContactSender, SendersPhone)
- `setServiceType(string $type)` - вариант доставки: WarehouseDoors, WarehouseWarehouse, DoorsWarehouse, DoorsDoors
- `setRecipient(array $recipient)` - данные получателя (массив с ключами: Recipient, CityRecipient, RecipientAddress, ContactRecipient, RecipientsPhone или RecipientsPhone, RecipientName, RecipientCityName, RecipientArea, RecipientAreaRegions, RecipientAddressName, RecipientHouse, RecipientFlat)
- `setPayerType(string $payerType)` - плательщик доставки (например, 'Sender')
- `setBackwardDeliveryData(int $amount)` - наложный платеж
- `setAfterpaymentOnGoodsCost(int $amount)` - контроль оплаты (имеет приоритет перед наложным платежом)
- `setAdditionalInformation(string $info)` - дополнительная информация
- `setOptionsSeat(array|int $weights)` - вес посылки или массив весов для нескольких мест

### Request Example
```php
$np = new InternetDocument;
$np->setAPI('c9********fd');
$sender = [
  'Sender' => 'a4***6b',
  'CitySender' => 'db5c88d0-391c-11dd-90d9-001a92567626',
  'SenderAddress' => '404***2cf',
  'ContactSender' => '86c***c6b',
  'SendersPhone' => '380965775815',
];
$np->setSender($sender);
$np->setServiceType('WarehouseDoors');
$recipient = [
  'Recipient' => '76****33',
  'CityRecipient' => '8d5a980d-391c-11dd-90d9-001a92567626',
  'RecipientAddress' => '2907******b8d',
  'ContactRecipient' => 'e5*****33',
  'RecipientsPhone' => '380997979789',
];
$np->setRecipient($recipient);
$np->setPayerType('Sender');
$np->setBackwardDeliveryData(386);
$np->setAdditionalInformation('Добавление информации');
$np->setOptionsSeat([1, 5, 10, 11]);
$createTTN = $np->save('Заявка №500. Одяг');
```

### Response
Возвращает результат создания ЭН (массив данных).
```

--------------------------------

### getCounterpartyAddresses() - load counterparty addresses by Ref

Source: https://github.com/daaner/novaposhta/blob/master/docs/Counterparty.md

Loads a list of counterparty addresses. Default property is 'Recipient' if not set; setting 'Sender' overrides it.

```php
$cp = new Counterparty;
//по умолчанию Recipient
$cp->setCounterpartyProperty('Sender'); // или насильно Recipient
$agent = $cp->getCounterpartyOptions("16b39437-c037-11ea-8513-b88303659df5");

dd($agent);
```

--------------------------------

### Use model helpers getPaymentForms and getCities

Source: https://github.com/daaner/novaposhta/blob/master/README.md

Shows helper methods: getPaymentForms on Common and getCities on Address with setLimit(5) and setPage(2) chained. Helpers are called before the main method.

```php
$foo = new Common;
$list = $foo->getPaymentForms();

$bar = new Address;
$bar->setLimit(5)->setPage(2);
$cities = $bar->getCities();

dd($cities);
```

--------------------------------

### Add NovaPoshta facade alias

Source: https://github.com/daaner/novaposhta/blob/master/README.md

Add the NovaPoshta facade alias to the aliases array in config/app.php.

```php
'NovaPoshta' => Daaner\NovaPoshta\Facades\NovaPoshta::class,
```
Tokens:
Raw