Skip to content

Commit

Permalink
Updated: README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lis-dev committed Mar 18, 2015
1 parent ad29a9a commit 41ff3c8
Showing 1 changed file with 84 additions and 67 deletions.
151 changes: 84 additions & 67 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,68 +79,79 @@ $result = $np->getDocumentPrice($sender_city_ref, $recipient_city_ref, 'Warehous
```
## Генерирование новой электронной накладной
```php
// Перед генерированием ЭН необходимо получить данные отправителя
// Получение всех отправителей
$senderInfo = $np->getCounterparties('Sender', 1, '', '');
// Выбор отправителя в конкретном городе (в данном случае - в первом попавшемся)
$sender = $senderInfo['data'][0];
// Информация о складе отправителя
$senderWarehouses = $np->getWarehouses($sender['City']);
// Генерирование новой накладной
$result = $np->newInternetDocument(
// Данные отправителя
array(
// Данные пользователя
'FirstName' => 'Петр',
'MiddleName' => 'Петрович',
'LastName' => 'Петров',
// Вместо FirstName, MiddleName, LastName можно ввести зарегистрированные ФИО отправителя или название фирмы для юрлиц
// (можно получить, вызвав метод getCounterparties('Sender', 1, '', ''))
'Description' => 'Иванов Иван Иванович',
// Необязательное поле, в случае отсутствия будет использоваться из данных контакта
'Phone' => '0631112233',
// Город отправления
'City' => 'Белгород-Днестровский',
// Область отправления
'Region' => 'Одесская',
// Отделение отправления
'Warehouse' => 'Отделение №2 (до 30 кг): ул. Дзержинского, 54',
),
// Данные получателя
array(
'FirstName' => 'Сидор',
'MiddleName' => 'Сидорович',
'LastName' => 'Сиродов',
'Phone' => '0509998877',
'City' => 'Киев',
'Region' => 'Киевская',
'Warehouse' => 'Отделение №3: ул. Калачевская, 13 (Старая Дарница)',
),
array(
// Дата отправления
'DateTime' => '13.12.2014',
// Тип доставки, дополнительно - getServiceTypes()
'ServiceType' => 'WarehouseWarehouse',
// Тип оплаты, дополнительно - getPaymentForms()
'PaymentMethod' => 'Cash',
// Кто оплачивает за доставку
'PayerType' => 'Recipient',
// Стоимость груза в грн
'Cost' => '500',
// Кол-во мест
'SeatsAmount' => '1',
// Описание груза
'Description' => 'Кастрюля',
// Тип доставки, дополнительно - getCargoTypes
'CargoType' => 'Cargo',
// Вес груза
'Weight' => '10',
// Объем груза в куб.м.
'VolumeGeneral' => '0.5',
// Обратная доставка
'BackwardDeliveryData' => array(
array(
// Кто оплачивает обратнку доставку
'PayerType' => 'Recipient',
// Тип доставки
'CargoType' => 'Money',
// Значение обратной доставки
'RedeliveryString' => 4552,
)
)
)
// Данные отправителя
array(
// Данные пользователя
'FirstName' => $sender['FirstName'],
'MiddleName' => $sender['MiddleName'],
'LastName' => $sender['LastName'],
// Вместо FirstName, MiddleName, LastName можно ввести зарегистрированные ФИО отправителя или название фирмы для юрлиц
// (можно получить, вызвав метод getCounterparties('Sender', 1, '', ''))
// 'Description' => $sender['Description'],
// Необязательное поле, в случае отсутствия будет использоваться из данных контакта
// 'Phone' => '0631112233',
// Город отправления
// 'City' => 'Белгород-Днестровский',
// Область отправления
// 'Region' => 'Одесская',
'CitySender' => $sender['City'],
// Отделение отправления по ID (в данном случае - в первом попавшемся)
'SenderAddress' => $senderWarehouses['data'][0]['Ref'],
// Отделение отправления по адресу
// 'Warehouse' => $senderWarehouses['data'][0]['DescriptionRu'],
),
// Данные получателя
array(
'FirstName' => 'Сидор',
'MiddleName' => 'Сидорович',
'LastName' => 'Сиродов',
'Phone' => '0509998877',
'City' => 'Киев',
'Region' => 'Киевская',
'Warehouse' => 'Отделение №3: ул. Калачевская, 13 (Старая Дарница)',
),
array(
// Дата отправления
'DateTime' => date('d.m.Y'),
// Тип доставки, дополнительно - getServiceTypes()
'ServiceType' => 'WarehouseWarehouse',
// Тип оплаты, дополнительно - getPaymentForms()
'PaymentMethod' => 'Cash',
// Кто оплачивает за доставку
'PayerType' => 'Recipient',
// Стоимость груза в грн
'Cost' => '500',
// Кол-во мест
'SeatsAmount' => '1',
// Описание груза
'Description' => 'Кастрюля',
// Тип доставки, дополнительно - getCargoTypes
'CargoType' => 'Cargo',
// Вес груза
'Weight' => '10',
// Объем груза в куб.м.
'VolumeGeneral' => '0.5',
// Обратная доставка
'BackwardDeliveryData' => array(
array(
// Кто оплачивает обратную доставку
'PayerType' => 'Recipient',
// Тип доставки
'CargoType' => 'Money',
// Значение обратной доставки
'RedeliveryString' => 4552,
)
)
)
);
```
## Получение складов в определенном городе
Expand All @@ -160,8 +171,10 @@ $result = $np
))
->execute();
```
## Реализованные методы для работы с моделями
# Модель InternetDocument

# Реализованные методы для работы с моделями

## Модель InternetDocument
* save
* update
* delete
Expand All @@ -174,7 +187,8 @@ $result = $np
* documentsTracking
* newInternetDocument
* generateReport
# Модель Counterparty

## Модель Counterparty
* save
* update
* delete
Expand All @@ -184,11 +198,13 @@ $result = $np
* getCounterpartyContactPersons
* getCounterpartyByEDRPOU
* getCounterpartyOptions
# Модель ContactPerson

## Модель ContactPerson
* save
* update
* delete
# Address

## Модель Address
* save
* update
* delete
Expand All @@ -197,7 +213,8 @@ $result = $np
* getWarehouses
* getAreas
* findNearestWarehouse
# Модель Common

## Модель Common
* getTypesOfCounterparties
* getBackwardDeliveryCargoTypes
* getCargoDescriptionList
Expand Down

0 comments on commit 41ff3c8

Please sign in to comment.