API ПВЗ — различия между версиями

Материал из Меасофт
Перейти к: навигация, поиск
(Получение файлов заказа)
(Список пользователей)
Строка 304: Строка 304:
 
         {
 
         {
 
             "code": 3,
 
             "code": 3,
            "extra": 100000,
 
 
             "name": "Основной",
 
             "name": "Основной",
             "login": "test1"
+
             "login": "test1",
 +
            "store": {
 +
                "code": "1",
 +
                "name": "Основной"
 +
            }
 
         }
 
         }
 
     ]
 
     ]
 
 
}
 
}
 
</source>
 
</source>
Строка 377: Строка 379:
 
}
 
}
 
</source>
 
</source>
 
  
 
==Список заказов==
 
==Список заказов==

Версия 16:02, 20 апреля 2021

ВНИМАНИЕ! ДАННАЯ СТАТЬЯ СОЗДАНА ДЛЯ СОТРУДНИКОВ КОМПАНИИ MEASOFT. ОНА ОПИСЫВАЕТ ЕЩЕ НЕ СУЩЕСТВУЮЩИЕ МЕТОДЫ, А КОГДА ОНИ БУДУТ РЕАЛИЗОВАНЫ - ОНИ НЕ БУДУТ ПРЕДНАЗНАЧЕНЫ ДЛЯ ИСПОЛЬЗОВАНИЯ НИКЕМ, КРОМЕ СОТРУДНИКОВ MEASOFT. ВСЕ СВЕДЕНИЯ, ОПИСАННЫЕ ЗДЕСЬ НЕ ИМЕЮТ К РЕАЛЬНОСТИ НИКАКОГО ОТНОШЕНИЯ. ВСЕ ФУНКЦИИ И МЕТОДЫ API ДЛЯ ИСПОЛЬЗОВАНИЯ КЛИЕНТАМИ, КЛИЕНТАМИ КЛИЕНТОВ, ПРОГРАММИСТАМИ КЛИЕНТОВ И КЛИЕНТОВ КЛИЕНТОВ, АГЕНТАМИ, ПВЗ, ПАРТНЕРАМИ И ПРОЧЕЕ, ОПИСАНЫ ТОЛЬКО В СТАТЬЕ API. Там представлена исчерпывающая функциональность для реализации практически всего, что вам придумается.


Общие понятия

Запрос выполняется на адрес https://home.courierexe.ru/pvzapi с заголовком "Content-Type: application/json". Данные указываются в теле запроса в виде JSON.

Ответ в случае ошибки

{
  "error" : "1",
  "errormessage" : { 
           "ru" : "Ошибка авторизации",
           "en" : "Auth error"
           }
}

Авторизация

Method: /auth

Запрос авторизации на основе клиента:

{
  "extra" : "8",
  "login" : "test",
  "pass" : "test"
}

Запрос авторизации пользователя:

{
  "login" : "test",
  "pass" : "test"
}

Ответ:

{
  "error" : "0",
  "token" : "wlefruhrfuefi4uh347h393r234r23w4"
}

Список аккаунтов

Method: /clients/list

Запрос:

{
  "token" : "wlefruhrfuefi4uh347h393r234r23w4"
}

Ответ:

{
  "error" : "0",
  "clients" : [
        {
          "code": "1", 
          "company": "Курьерская служба Прима",
          "companyfull": "ООО Курьерская служба Прима",
          "address": "Ленина, д. 1, корп. 1, оф. 1",
          "addressfull": "124365 г.Москва, ул. Ленина, д. 1, корп. 1, оф. 1",
          "director": "Иванов Иван",
          "name": "Иванов Игнат",
          "phone": "123-45-01",
          "phone2": "123-67-01",
          "email": "prima@mail.ru",
          "inn": "77000000001",
          "kpp": "770001",
          "login": "prima",
          "firm": 1,
          "firmclient": "1"
        },
        {
          "code": "2", 
          "company": "Курьерская служба Секунда",
          "companyfull": "ООО Курьерская служба Секунда",
          "address": "Добровольческая ул., 12",
          "addressfull": "127000, г. Москва, ул. Добровольческая, дом 12",
          "director": "Петров Петр",
          "name": "Петров Прохор",
          "phone": "123-45-02",
          "phone2": "123-67-02",
          "email": "secunda@mail.ru",
          "inn": "77000000002",
          "kpp": "770002",
          "login": "secunda",
          "firm": 1,
          "firmclient": "1"
        }
   ]
}


Создание

Method: /clients/create

Запрос на создание аккаунта на основе клиента:

{
  "token" : "wlefruhrfuefi4uh347h393r234r23w4",
  "extra" : "8",
  "login" : "test1",
  "pass" : "test1",
  "town" : 1
}

Ответ:

{
  "error" : "0",
  "result": "Ok"
}

Редактирование

Method: /clients/update

Запрос:

{
  "token" : "wlefruhrfuefi4uh347h393r234r23w4",
  "code" : "12345",
  "company" : "Курьерская служба Большая Терция",
  "name": "Иванов Иван 2",
  "address": "улица донецкая 132",
  "phone": "247-11-22",
  "fullcompany": "ООО Курьерская служба",
  "gendir": "Прокофьев М.Л.",
  "inn": "770123456",
  "kpp": "774512",
  "fulladdress": "123456, Москва, ул. Донецкая, 132",
  "bank": "ОАО Банк Первый",
  "rsh": "1234567890123456789",
  "ksh": "1234567890001234567",
  "bik": "112233",
  "mail": "ks@company.ru",
  "phone2": "247-22-33",
  "dolgnost": "Бухгалтер",
  "gruz": "",
  "okpo": "",
  "okved": "",
  "okvedname": "",
  "ogrn": ""
}

Ответ:

{
  "error" : "0",
  "result": "Ok"
}


Удаление

Method: /clients/delete

Запрос:

{
  "token" : "wlefruhrfuefi4uh347h393r234r23w4",
  "code" : "12345"
}

Ответ:

{
  "error" : "0",
  "result": "Ok"
}

Список филиалов

Method: /stores/list

Запрос:

{
  "token" : "wlefruhrfuefi4uh347h393r234r23w4"
}

Ответ:

{
  "error" : "0",
  "accounts" : [
        {
          "code": 1,
          "name": "ПВЗ на Гайве",
          "address": "Ленина, 5",
          "fio": "Иванов Иван Иванович",
          "phone": "111222333"
        },
        {
          "code": "2", 
          "name": "ПВЗ на Крохалях",
          "address": "Курьерский переулок, 10",
          "fio": "Дональд Трамп",
          "phone": "123-44-55"
        }

   ]
}


Создание

Method: /stores/create

Запрос:

{
  "token" : "wlefruhrfuefi4uh347h393r234r23w4",
  "name" : "ПВЗ на Парковом",
  "address": "проспект Парковый, 10",
  "fio": "Константин Симонов",
  "phone": "267-11-22"
}

Ответ:

{
  "error" : "0",
  "result": "Ok"
}


Редактирование

Method: /stores/update

Запрос:

{
  "token" : "wlefruhrfuefi4uh347h393r234r23w4",
  "code" : "2",
  "name" : "ПВЗ на Парковом",
}

Ответ:

{
  "error" : "0",
  "result": "Ok"
}


Удаление

Method: /stores/delete

Запрос:

{
  "token" : "wlefruhrfuefi4uh347h393r234r23w4",
  "code" : "2"
}

Ответ:

{
  "error" : "0",
  "result": "Ok"
}


Список пользователей

Method: /users/list

Запрос:

{
  "token" : "wlefruhrfuefi4uh347h393r234r23w4"
}

Ответ:

{
    "error": 0,
    "users": [
        {
            "code": 3,
            "name": "Основной",
            "login": "test1",
            "store": {
                "code": "1",
                "name": "Основной"
            }
        }
    ]
}

Создание

Method: /users/create

Запрос:

{
  "token" : "wlefruhrfuefi4uh347h393r234r23w4",
  "name": "Новый пользователь",
  "login": "user_login",
  "pass": "user_pass"
}

Ответ:

{
  "error" : "0",
  "result": "Ok"
}

Редактирование

Method: /users/update

Запрос:

{
  "token" : "wlefruhrfuefi4uh347h393r234r23w4",
  "code": "5",
  "name": "Имя пользователя",
  "login": "new_login",
  "pass": "new_pass"
}

Ответ:

{
  "error" : "0",
  "result": "Ok"
}

Удаление

Method: /users/list

Запрос:

{
  "token" : "wlefruhrfuefi4uh347h393r234r23w4",
  "code": "5"
}

Ответ:

{
  "error" : "0",
  "result": "Ok"
}

Список заказов

Method: /address/list

Запрос:

{
  "token": "wlefruhrfuefi4uh347h393r234r23w4",
  "changed": 1,
  "code": 1,
  "number": 1,
  "name": 1,
  "phone": 1,
  "begindate": 1,
  "enddate": 1,
  "status": 1
}

Описание полей

  • code - Код заказа
  • number - Номер заказа
  • name - Имя получателя или наименование компании-получателя
  • phone - Телефон получателя
  • begindate - Дата заказа "с"
  • enddate - Дата заказа "по"
  • status - Код заказа

Если не передано ни одно из полей, то выдаются только изменившиеся заказы.


Ответ:

{
  "error" : "0",
  "orders" : [
        {
            "ordercode": -108223640,
            "orderno": "dsf002524",
            "barcode": "dsf002524",
            "client": {
                "code": "2",
            },
            "sender": {
                "company": "ФЛОРА 2222",
                "person": "Ирина Тимошенко",
                "address": "Ростов-на- Дону, Киргизская ул., 25",
                "phone": "8-918-620-50-99",
                "contacts": {
                    "phones": [
                        "+79186205099"
                    ]
                },
                "date": null,
                "time_min": null,
                "time_max": null,
                "town": {
                    "name": "1",
                    "code": "Москва город",
                    "regioncode": "77",
                    "regionname": "Москва город"
                }
            },
            "receiver": {
                "company": "картит",
                "person": "картит",
                "address": "Крещатик ул., 5",
                "phone": "9161147992",
                "contacts": {
                    "phones": [
                        "+79161147992"
                    ],
                    "emails": [
                        "receiver@mail.ru"
                    ]
                },
                "date": "2020-05-28",
                "time_min": "12:00:00",
                "time_max": "15:00:00",
                "pvz": "",
                "town": {
                    "name": "300000",
                    "code": "Киев город",
                    "regioncode": "1309",
                    "regionname": "Киевская область"
                }
            },
            "price": 1000,
            "inshprice": 1000,
            "quantity": 2,
            "weight": 35.1,
            "paytype": "OTHER",
            "receiverpays": "NO",
            "service": 1,
            "type": 1,
            "return": "F",
            "return_service": 1,
            "return_type": 1,
            "instruction": "",
            "enclosure": "",
            "deliveredto": "Примечание",
            "delivereddate": "",
            "deliveredtime": "",
            "costcode": "",
            "outstrbarcode": "",
            "otdel": "",
            "smacode": "67",
            "scacode": null,
            "deliveryset": {
                "return_price": 350,
                "above_price": 100,
                "below": [
                    {
                        "below_sum": 6000,
                        "price": 200
                    }
                ]
            },
            "deliveryprice": {
                "total": "100.00",
                "delivery": "100.00",
                "return": "0.00",
                "advprices": [
                    {
                        "code": 1,
                        "price": "100.00",
                        "name": "Базовая цена"
                    }
                ]
            },
            "status": {
                "name": "PICKUPREADY",
                "title": "Готов к выдаче",
                "message": "",
                "eventtime": "2020-05-30 19:30:29",
                "eventstore": "Тест ПВЗ",
                "createtimegmt": "2020-05-30 16:30:29"
            },
            "statushistory": [
                {
                    "name": "NEW",
                    "title": "Новый",
                    "country": "RU",
                    "message": "",
                    "eventtime": "2020-05-30 16:32:33",
                    "eventstore": "Тест ПВЗ",
                    "createtimegmt": "2020-05-30 13:32:33"
                },
                {
                    "name": "PICKUPREADY",
                    "title": "Готов к выдаче",
                    "country": "RU",
                    "message": "",
                    "eventtime": "2020-05-30 19:30:29",
                    "eventstore": "Тест ПВЗ",
                    "createtimegmt": "2020-05-30 16:30:29"
                }
            ],
            "items": [
                {
                    "code": -108297629,
                    "mass": 0.1,
                    "name": "Ножницы для ногтей Zinger Premium 2302 salon, салонная заточка",
                    "type": 1,
                    "width": 0,
                    "height": 0,
                    "length": 0,
                    "VATrate": 20,
                    "article": "",
                    "barcode": "",
                    "extcode": "487307",
                    "returns": 0,
                    "suppINN": "",
                    "quantity": 1,
                    "retprice": 1170,
                    "suppphone": "",
                    "suppcompany": "",
                    "governmentCode": ""
                },
                {
                    "code": -108297630,
                    "mass": 0,
                    "name": "Доставка ГОРОД",
                    "type": 1,
                    "width": 0,
                    "height": 0,
                    "length": 0,
                    "VATrate": 20,
                    "article": "",
                    "barcode": "",
                    "extcode": "487308",
                    "returns": 0,
                    "suppINN": "",
                    "quantity": 1,
                    "retprice": 250,
                    "suppphone": "",
                    "suppcompany": "",
                    "governmentCode": ""
                }
            ],
            "packages": [
                {
                    "got": "NO",
                    "code": -108297640,
                    "mass": 0.1,
                    "name": "Место 1",
                    "width": 0,
                    "height": 0,
                    "length": 0,
                    "barcode": "",
                    "message": ""
                }
            ]
        }
   ]
}

Подтверждение получения списка

Method: /address/commit

Запрос:

{
  "token" : "wlefruhrfuefi4uh347h393r234r23w4"
}

Ответ:

{
  "error" : "0",
  "result": "Ok"
}

Установка статусов

Method: /address/update

Запрос:

{
  "token": "wlefruhrfuefi4uh347h393r234r23w4",
  "code": "12345",
  "status": "9",
  "message": "Заказ доставлен",
  "date": "2020-06-10",
  "time": "16:12",
  "price": "500",
  "paytype": "2",
  "items": [
    {
      "code": 2,
      "quantity": 1,
      "reason": 3,
      "governmentCode": "010405915621911121MimQ57zZJBpPt91ffd0929S/IuD8i9VR+vmmTDcQgrUYKTfMsCud0f1cs4WrF3QPTt8GeXZlDQoynO4bep5eyknZNW2pYNvuCsy07AEe6/A=="
    }
  ],
  "files": [
    {
      "filename": "file.jpg",
      "file": "/9j/4AAQSkZJRgABAQAAAQABAAD/2 BDAA0JCgsKCA0LCgsODg0PEyAVExI
               SEyccHhcgLikxMC4pLSwzOko+MzZG NywtQFdBRkxOUlNSMj5aYVpQYEpRU
               k//2wBDAQ4ODhMREyYVFSZPNS01T0 9PT09PT09PT09PT09PT09PT09PT09
               PT09PT09PT09PT09PT09PT09PT09P T09PT0//wAARCAEsASUDASIAAhEBA
               xEB/8QAFgABAQEAAAAAAAAAAAAAAA AAAAUH/8QAIRABAAEEAgEFAAAAAAA
               AAAAAAAEDBAURAkEhBhIxcfH/xAAU AQEAAAAAAAAAAAAAAAAAAAAA/8QAF
               BEBAAAAAAAAAAAAAAAAAAAAAP/aAA wDAQACEQMRAD8A04AAAAAAAAAAAAA
               AAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAA"
    }
  ]
}

Ответ:

{
  "error" : "0",
  "result": "Ok"
}


Добавление файлов к заказу

Method: /address/files

Запрос:

{
  "token": "wlefruhrfuefi4uh347h393r234r23w4",
  "code": "12345",
  "files": [
    {
      "filename": "file.jpg",
      "file": "/9j/4AAQSkZJRgABAQAAAQABAAD/2 BDAA0JCgsKCA0LCgsODg0PEyAVExI
               SEyccHhcgLikxMC4pLSwzOko+MzZG NywtQFdBRkxOUlNSMj5aYVpQYEpRU
               k//2wBDAQ4ODhMREyYVFSZPNS01T0 9PT09PT09PT09PT09PT09PT09PT09
               PT09PT09PT09PT09PT09PT09PT09P T09PT0//wAARCAEsASUDASIAAhEBA
               xEB/8QAFgABAQEAAAAAAAAAAAAAAA AAAAUH/8QAIRABAAEEAgEFAAAAAAA
               AAAAAAAEDBAURAkEhBhIxcfH/xAAU AQEAAAAAAAAAAAAAAAAAAAAA/8QAF
               BEBAAAAAAAAAAAAAAAAAAAAAP/aAA wDAQACEQMRAD8A04AAAAAAAAAAAAA
               AAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAA"
    }
  ]
}

Ответ:

{
  "error" : "0",
  "result": "Ok"
}


Получение файлов заказа

Method: /address/files

Запрос:

{
  "token": "wlefruhrfuefi4uh347h393r234r23w4",
  "code": "12345"
}

Ответ:

{
  "error" : "0",
  "files": [
    {
      "filename": "file.jpg",
      "file": "/9j/4AAQSkZJRgABAQAAAQABAAD/2 BDAA0JCgsKCA0LCgsODg0PEyAVExI
               SEyccHhcgLikxMC4pLSwzOko+MzZG NywtQFdBRkxOUlNSMj5aYVpQYEpRU
               k//2wBDAQ4ODhMREyYVFSZPNS01T0 9PT09PT09PT09PT09PT09PT09PT09
               PT09PT09PT09PT09PT09PT09PT09P T09PT0//wAARCAEsASUDASIAAhEBA
               xEB/8QAFgABAQEAAAAAAAAAAAAAAA AAAAUH/8QAIRABAAEEAgEFAAAAAAA
               AAAAAAAEDBAURAkEhBhIxcfH/xAAU AQEAAAAAAAAAAAAAAAAAAAAA/8QAF
               BEBAAAAAAAAAAAAAAAAAAAAAP/aAA wDAQACEQMRAD8A04AAAAAAAAAAAAA
               AAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAA"
    }
  ]
}

Справочная информация

Method: /info

Запрос:

{
  "token": "wlefruhrfuefi4uh347h393r234r23w4",
  "devicename": "Наименование устройства",
  "devicetime": "Время устройства",
  "appversion": "Версия приложения",
  "apiversion": "Версия API",
  "iosversion": "Версия iOS",
  "gpsenabled": "GPS включен",
  "netenabled": "Сеть включена",
  "settings": "Настройки"
}

Ответ:

{
    "error": 0,
    "values": {
        "countrycode": "1",
        "defaultcurrency": "р."
    },
    "types": {
        "0": [
            {
                "code": 0,
                "name": "Ожидает синхронизации"
            },
            {
                "code": 1,
                "name": "Новый"
            },
            {
                "code": 2,
                "name": "Забран у отправителя"
            },
            {
                "code": 3,
                "name": "Получен складом"
            },
            {
                "code": 4,
                "name": "Инвентаризация"
            },
            {
                "code": 5,
                "name": "Планируется отправка"
            },
            {
                "code": 6,
                "name": "Отправлено со склада"
            },
            {
                "code": 7,
                "name": "Выдан курьеру на доставку"
            },
            {
                "code": 8,
                "name": "Доставлен (предварительно)"
            },
            {
                "code": 9,
                "name": "Доставлен"
            },
            {
                "code": 10,
                "name": "Доставлен частично"
            },
            {
                "code": 11,
                "name": "Курьер вернул на склад"
            },
            {
                "code": 12,
                "name": "Не доставлен (Возврат/Отмена)"
            },
            {
                "code": 13,
                "name": "Планируется возврат"
            },
            {
                "code": 14,
                "name": "Возвращен"
            },
            {
                "code": 15,
                "name": "Скомплектован на складе"
            },
            {
                "code": 16,
                "name": "Разукомплектован"
            },
            {
                "code": 17,
                "name": "Согласована доставка"
            },
            {
                "code": 18,
                "name": "Перенос"
            },
            {
                "code": 19,
                "name": "Создан забор"
            },
            {
                "code": 20,
                "name": "Не удалось согласовать доставку"
            },
            {
                "code": 21,
                "name": "Готов к выдаче"
            },
            {
                "code": 22,
                "name": "Утрачен"
            },
            {
                "code": 23,
                "name": "Частично со слов курьера"
            },
            {
                "code": 24,
                "name": "Отказ со слов курьера"
            },
        ],
        "1": [
            {
                "code": 1,
                "name": "Недозвон"
            },
            {
                "code": 2,
                "name": "Передумал"
            },
            {
                "code": 3,
                "name": "Уже купил"
            },
            {
                "code": 4,
                "name": "Нет денег"
            }
        ]
    }
}

Принятие мест

Method: /packages/get

Запрос:

{
  "token" : "wlefruhrfuefi4uh347h393r234r23w4",
  "code": "5"
}

Ответ:

{
  "error" : "0",
  "result": "Ok"
}


Список актов передачи денег

Method: /sma/list

Запрос:

{
  "token" : "wlefruhrfuefi4uh347h393r234r23w4",
  "clientcode" : 2,
  "datefrom" : "2020-10-10",
  "dateto" : "2020-10-11"
}

Ответ:

{
    "error": 0,
    "sma": [
        {
            "code": 6278,
            "number": 3992,
            "clientcode": 2,
            "actdate": "2020-10-10",
            "datepay": false,
            "dateto": "2020-10-10",
            "promiseddatepay": false,
            "price": 637.00,
            "pricecorr": 113.00,
            "rur": 13430.00,
            "pricekur": 570.00,
            "priceag": 67.00,
            "payno": 42423,
            "paytype": 1,
            "paytypename": "Безнал",
            "signedcopyreceived": "NO"
        }
    ]
}


Описание полей

  • code - Код АПД
  • number - Номер АПД
  • clientcode - Код клиента
  • actdate - Дата акта
  • datepay - Дата оплаты по акту
  • dateto - Дата конечного периода для формирования АПД
  • promiseddatepay - Плановая дата оплаты
  • price - Стоимость услуг
  • pricecorr - Сумма корректировки
  • rur - Сумма заказа
  • pricekur - Стоимость курьерской доставки
  • priceag - Агентское вознаграждение
  • payno - Номер платежного поручения
  • paytype - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту
  • paytypename - Строковое представление типа оплаты
  • signedcopyreceived - Признак факта возврата акта YES/NO

Создание акта передачи денег

Method: /sma/create

Запрос:

{
  "token" : "wlefruhrfuefi4uh347h393r234r23w4",
  "clientcode": 1,
  "price": 1000,
  "message": "Комментарий",
  "paytype": 2,
  "specialsma": [
    {
      "addresscode": 3448518,
      "sum": 10000,
      "price": 1000,
      "pricekur": 100,
      "priceag": 10,
      "correction": 0,
      "made": 0,
      "dateput": "",
      "receiverpays": 0
    },
    {
      "addresscode": 3448519,
      "sum": 20000,
      "price": 2000,
      "pricekur": 200,
      "priceag": 20,
      "correction": 0,
      "made": 0,
      "dateput": "",
      "receiverpays": 1
    }
  ]
}


Описание полей

  • clientcode - Код клиента
  • price - Сумма к передаче по акту
  • message - Комментарий
  • paytype - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту
  • specialsma - Массив объектов, детализаций актов

Поля объекта детализации:

  • addresscode - Код адреса
  • sum - Сумма заказа
  • price - Стоимость услуг
  • pricekur - Стоимость курьерской доставки
  • priceag - Агентское вознаграждение
  • correction - Сумма корректировки
  • made - Признак доставленности, булево значение, равное 1, если дата доставки и время доставки адреса не NULL
  • dateput - Дата вручения заказа
  • receiverpays - Признак оплаты заказа получателем, булево значение


Ответ:

{
  "error" : "0",
  "result": "Ok"
}


Список актов передачи корреспонденций

Method: /sca/list

Запрос:

{
  "token" : "wlefruhrfuefi4uh347h393r234r23w4",
  "clientcode" : 2,
  "datefrom" : "2020-10-10",
  "dateto" : "2020-10-11"
}

Ответ:

{
    "error": 0,
    "sma": [
        {
            "code": 6278,
            "number": 3992,
            "clientcode": 2,
            "actdate": "2020-10-10",
            "datepay": false,
            "dateto": "2020-10-10",
            "promiseddatepay": false,
            "price": 637.00,
            "pricecorr": 113.00,
            "rur": 13430.00,
            "pricekur": 570.00,
            "priceag": 67.00,
            "payno": 42423,
            "paytype": 1,
            "paytypename": "Безнал",
            "address": [
                {"code": 3447381, "boxcode": 498863}
            ]
        }
    ]
}


Описание полей

  • code - Код АПК
  • number - Номер АПК
  • clientcode - Код клиента
  • actdate - Дата акта
  • datepay - Дата оплаты по акту
  • dateto - Дата конечного периода для формирования АПК
  • promiseddatepay - Плановая дата оплаты
  • price - Стоимость услуг
  • pricecorr - Сумма корректировки
  • rur - Сумма заказа
  • pricekur - Стоимость курьерской доставки
  • priceag - Агентское вознаграждение
  • payno - Номер платежного поручения
  • paytype - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту
  • paytypename - Строковое представление типа оплаты
  • address - список кодов заказов из АПК и кодов вложений


Создание акта передачи корреспонденций

Method: /sca/create

Запрос:

{
  "token" : "wlefruhrfuefi4uh347h393r234r23w4",
  "clientcode": 1,
  "price": 1000,
  "message": "Комментарий",
  "paytype": 2,
  "returns": [
    {
      "addresscode": 3448518,
      "sum": 10000,
      "price": 1000,
      "pricekur": 100,
      "priceag": 10,
      "correction": 0,
      "made": 0,
      "dateput": "",
      "receiverpays": 0,
      "boxcode": 3447381,
      "quantity": 1
    },
    {
      "addresscode": 3448519,
      "sum": 20000,
      "price": 2000,
      "pricekur": 200,
      "priceag": 20,
      "correction": 0,
      "made": 0,
      "dateput": "",
      "receiverpays": 1
    }
  ]
}


Описание полей

  • clientcode - Код клиента
  • price - Сумма к передаче по акту
  • message - Комментарий
  • paytype - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту
  • returns - Массив объектов, детализаций актов

Поля объекта детализации:

  • addresscode - Код адреса
  • sum - Сумма заказа
  • price - Стоимость услуг
  • pricekur - Стоимость курьерской доставки
  • priceag - Агентское вознаграждение
  • correction - Сумма корректировки
  • made - Признак доставленности, булево значение, равное 1, если дата доставки и время доставки адреса не NULL
  • dateput - Дата вручения заказа
  • receiverpays - Признак оплаты заказа получателем, булево значение
  • boxcode - Код товарного вложения, если частичная доставка
  • quantity - Количество возвратного товара вложения

Список населенных пунктов

Method: /towns/list

Запрос:

{
  "token": "53f9690d3951556801633b3d84055b0e",
  "name": "калинин калинин"
}

Минимальная длина наименования - 3 символа.

Ответ:

{
    "error": 0,
    "towns": [
        {
            "code": "58437",
            "name": "Калининград город",
            "region": "Калининградская область"
        },
        {
            "code": "59034",
            "name": "Калинино поселок",
            "region": "Калининградская область"
        },
        {
            "code": "58800",
            "name": "Калининское поселок",
            "region": "Калининградская область"
        }
    ]
}

Список улиц населенного пункта

Method: /streets/list

Запрос:

{
  "token": "53f9690d3951556801633b3d84055b0e",
  "town": 1,
  "name": "кар"
}

Минимальная длина наименования - 3 символа

Ответ:

{
    "error": 0,
    "streets": [
        "Карамзина проезд",
        "Карамышевская наб.",
        "Карамышевский проезд",
        "Карачаровская ул.",
        "Карачаровское шоссе",
        "Каргопольская ул.",
        "Карелин проезд",
        "Карельский бульвар",
        "Каретный Ряд ул.",
        "Карманицкий пер.",
        "Карьер ул.",
        "Карьерная ул."
    ]
}

Список документов

Создание

Подтверждение вхождения заказа

Исключение заказа