Начало

Полная документация к API FSDelivery.ru

Для авторизации по любому запросу необходимо получение JWT токена. Получить токен можно в личном кабинете.

Описание передаваемых данных

* - помечены обязательные параметры в запросе.
** - помечены параметры в запросе, требующие ознакомления с инструкцией.

Документация находится в стадии актуализации и наполнения. Если у вас есть вопросы по использованию Api отправьте запрос в телеграм t.me/Fsdelivery_support

  URL для запросов к API
  
       https://api.fsdelivery.ru/1.0/
                

Калькулятор тарифов

Получить информацию по стоимости услуг доставки

Адрес для запроса
https://api.fsdelivery.ru/1.0/tariff/calculation

Обязательные заголовки в запросе
X-API-TOKEN: ваш токен для авторизации

Описание передаваемых данных

Параметр Тип Описание
type_id массив ID режима доставки по базе FsDelivery.ru
delivery_company_id массив ID служб доставки
add_items_prices bool Учитывать ли в калькуляции товары
4. packages * массив Грузоместа
4.1 length string Длинна в см
4.2 height string высота в см
4.3 width string Ширина в см
4.4 weight float вес в кг
sender_city_id ** int ID города отправителя по базе FsDelivery.ru
reciver_city_id ** int ID города получателя по базе FsDelivery.ru
sender_city_kladr string КЛАДР города отправителя
reciver_city_kladr string КЛАДР города получателя
sender_city_fias string ФИАС города отправителя
reciver_city_fias string ФИАС города получателя
sender_city_index string Почтовый индекс города отправителя
reciver_city_index string Почтовый индекс города получателя

Пояснение

Город отправитель идентифицируется или по sender_city_id или по sender_city_kladr или по sender_city_fias или по sender_city_index
Город получатель идентифицируется или по reciver_city_id или по reciver_city_kladr или по reciver_city_fias или по reciver_city_index

Возможные ошибки в ответе

Типовые ошибки присущие всем методам API указаны в конце документации. Ниже список ошибок, которые может вернуть метод, помимо общих ошибок, присущих всем методам.

ID Сообщение
10004 В запросе присутствуют некорректные параметры: %s
10007 Параметр %s должен состоять только из цифр
10008 Служба доставки с таким ID не найдена
10010 Отсутствует обязательный параметр %s
10019 Параметр %s может принимать значения 0, 1, false или true
10022 Параметр %s должен быть массивом
10030 Параметр %s должен быть целым числом или числом с плавающей точкой
10031 Должен быть передан город отправителя
10032 Должен быть передан город получателя
10033 По заданным параметрам город отправителя не найден
10034 По заданным параметрам город получателя не найден
10035 Должно быть передано хотя бы одно место (packages)
10036 Для клиентов без договора поле %s обязательно
10037 Параметр %s может принимать значения %s
POST

{
"sender_city_id":44,
"reciver_city_index":"630001",
"tariff_id_list":[136,137,233,234,4000,4001,4003], // выбрали список тарифов которые нужны
"add_items_prices":0,
"delivery_company_id":[1,55], // выбрали две службы доставки
"packages": [{
"length":"1",
"width":"1",
"height":"1",
"weight":"0.5"}]
}
  
     
Пример ответа, где одна служба не отвечает :
{
    "request_id": "ba34eb3d-314a-4e2a-9207-9823bf0cedb5",
    "tariffs": {
        "1": {
            "136": {
                "tariff_id": 136,
                "min_day": 2,
                "max_day": 3,
                "sum": "590",
                "total_sum": "590",
                "tariff_name": "Посылка склад-склад"
            },
            "137": {
                "tariff_id": 137,
                "min_day": 2,
                "max_day": 3,
                "sum": "730",
                "total_sum": "730",
                "tariff_name": "Посылка склад-дверь"
            },
            "233": {
                "tariff_id": 233,
                "min_day": 4,
                "max_day": 5,
                "sum": "350",
                "total_sum": "350",
                "tariff_name": "Экономичная посылка склад-дверь"
            },
            "234": {
                "tariff_id": 234,
                "min_day": 4,
                "max_day": 5,
                "sum": "230",
                "total_sum": "230",
                "tariff_name": "Экономичная посылка склад-склад"
            },
            "delivery_company_id": 1,
            "delivery_company_name": "Cdek"
        },
        "55": {
            "error": "Сервера транспортной компании недоступны",
            "delivery_company_id": 55,
            "delivery_company_name": "RussianPost"
        }
    }
}
            


Рекомендация:
Несмотря на максимально возможную реализацию по производительности ( со своей стороны мы делаем параллельные запросы списками в службы доставки )
Рекомендуется использовать фильтрацию по:
type_id ( по режиму доставки, например только тарифы склад-склад )
tariff_id_list ( список тарифов, например часть тарифов от каждой службы )
delivery_company_id ( по службам доставки )

Несмотря на быстрое получение тарифов, сэкономленное время на фильтрацию ненужных тарифов положительно скажется на ваших клиентах.



Пример PHP и обработка запроса   

Список курьерских служб

Получить иформацию о службах доставки, подключенных к сервису.

Адрес для запроса
https://api.fsdelivery.ru/1.0/delivery/list

Обязательные заголовки в запросе
X-API-TOKEN: ваш токен для авторизации

Передаваемые данные отсутствуют.

Возможные ошибки в ответе

Метод может вернуть только общую ошибку, присущую для любого метода. Типовые ошибки присущие всем методам API указаны в конце документации.

GET

Пример запроса:

{
    // пустой GET запрос на страницу без параметров.
}
          
			
           
Пример ответа :
{
   "request_id": "751823b4-dcd0-4dcd-95f2-a76094be623c",
   "code": 20000,
   "delivery_list":    [
               {
         "id": 50,
         "name": "FsDelivery" 
      },
	                 {
         "id": 51,
         "name": "FastDo" 
      },
	     "id": 55,
         "name": "RussianPost" 
      },
            {
         "id": 1,
         "name": "Cdek" 
      },
            {
         "id": 2,
         "name": "Boxberry" 
      },
            {
         "id": 3,
         "name": "Cse" 
      },
            {
         "id": 4,
         "name": "Iml" 
      },
            {
         "id": 5,
         "name": "Dpd" 
      },
            {
         "id": 6,
         "name": "Pek" 
      },
            {
         "id": 7,
         "name": "DelLin" 
      }
   ]
}
            


В ответе можно увидеть полный список поддерживаемых служб доставки.
Ответ не учитывает службы, активированные или деактивированные для вашего аккаунта.
Список активных служб доставки для вашего договора можно получить в запросе на 
получение информации о пользователе.      



Пример PHP и обработка запроса   

Список режимов доставки

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

Адрес для запроса
https://api.fsdelivery.ru/1.0/delivery/types

Обязательные заголовки в запросе
X-API-TOKEN: ваш токен для авторизации

Описание передаваемых данных

Параметр Тип Описание
type_id int ID режима доставки по базе FsDelivery.ru

Возможные ошибки в ответе

Метод может вернуть только общую ошибку, присущую для любого метода. Типовые ошибки присущие всем методам API указаны в конце документации.

POST

Пример запроса:

{
    "type_id": 4 // 4 ( дверь дверь ) - режим доставки из метода getTypes 
}
         
Пример ответа :
{ // возвращает список служб, которые доставляют в заданном режиме

   "request_id": "e8a5dbc8-7533-4b02-9263-69889ad2f317",
   "types":    [
            {
         "delivery_company_id": 0, // ID службы доставки из метода /1.0/delivery/list
         "delivery_company_name": "FSDelivery", // название службы доставки
         "type_id": 4, // Режим доставки
         "name": "Дверь-Дверь" // название режима доставки
      },
            { // ещё служба
         "delivery_company_id": 1, // ID службы доставки из метода /1.0/delivery/list
         "delivery_company_name": "Cdek", // название службы доставки
         "type_id": 4, // Режим доставки
         "name": "Дверь-Дверь" // название режима доставки
      }
   ]
}
            


Есть 4 режима доставки: склад-склад, склад-дверь, дверь-склад, дверь-дверь.
В разных службах доступны разные режимы доставки. Метод позволяет получить 
список служб и доступных режимов доставки для каждой службы.   
Для полного списка отправляется пустой запрос, для сортировки по режиму
в запрос добавляется

{
type_id: 1 // id режима
}

1 - Склад - Склад
2 - Склад - Дверь
3 - Дверь - Склад
4 - Дверь - Дверь




Пример PHP и обработка запроса   

Список доступных тарифов

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

Адрес для запроса
https://api.fsdelivery.ru/1.0/delivery/tariffs

Обязательные заголовки в запросе
X-API-TOKEN: ваш токен для авторизации

Описание передаваемых данных

Параметр Тип Описание
type_id int ID режима доставки по базе FsDelivery.ru
delivery_company_id int ID службы доставки по базе FsDelivery.ru

Возможные ошибки в ответе

Метод может вернуть только общую ошибку, присущую для любого метода. Типовые ошибки присущие всем методам API указаны в конце документации.

POST

Пример запроса:

{
    "type_id": 1 // 4 ( дверь дверь ) - режим доставки из метода getTypes 
	// не обязательный параметр, для получения всех тарифов - пустой запрос.
}
         
Пример ответа :
{
    "request_id": "8751efc0-d6ef-41d5-88ca-eb89fbb406a4",
    "tariffs": [
        {
            "id": 140,
            "name": "Возврат склад-склад",
            "delivery_company_id": 1,
            "type_id": 1
        },
        {
            "id": 141,
            "name": "Возврат склад-дверь",
            "delivery_company_id": 1,
            "type_id": 2
        },
        {
            "id": 142,
            "name": "Возврат дверь-склад",
            "delivery_company_id": 1,
            "type_id": 0
        },
        {
            "id": 143,
            "name": "Возврат дверь-дверь",
            "delivery_company_id": 1,
            "type_id": 4
        },
        {
            "id": 136,
            "name": "Посылка склад-склад",
            "delivery_company_id": 1,
            "type_id": 1
        },
        {
            "id": 137,
            "name": "Посылка склад-дверь",
            "delivery_company_id": 1,
            "type_id": 2
        },
        {
            "id": 138,
            "name": "Посылка дверь-склад",
            "delivery_company_id": 1,
            "type_id": 3
        },
        {
            "id": 139,
            "name": "Посылка дверь-дверь",
            "delivery_company_id": 1,
            "type_id": 4
        },
        {
            "id": 10,
            "name": "Экспресс лайт склад-склад",
            "delivery_company_id": 1,
            "type_id": 1
        },
        {
            "id": 11,
            "name": "Экспресс лайт склад-дверь",
            "delivery_company_id": 1,
            "type_id": 2
        },
        {
            "id": 12,
            "name": "Экспресс лайт дверь-склад",
            "delivery_company_id": 1,
            "type_id": 3
        },
        {
            "id": 158,
            "name": "Единый забор всех посылок",
            "delivery_company_id": 1,
            "type_id": 3
        },
        {
            "id": 1,
            "name": "Экспресс лайт дверь-дверь",
            "delivery_company_id": 1,
            "type_id": 4
        },
        {
            "id": 62,
            "name": "Магистральный экспресс склад-склад",
            "delivery_company_id": 1,
            "type_id": 1
        },
        {
            "id": 63,
            "name": "Магистральный супер-экспресс склад-склад",
            "delivery_company_id": 1,
            "type_id": 1
        },
        {
            "id": 234,
            "name": "Экономичная посылка склад-склад",
            "delivery_company_id": 1,
            "type_id": 1
        },
        {
            "id": 233,
            "name": "Экономичная посылка склад-дверь",
            "delivery_company_id": 1,
            "type_id": 2
        },
        {
            "id": 5,
            "name": "Экономичный экспресс склад-склад",
            "delivery_company_id": 1,
            "type_id": 0
        },
        {
            "id": 15,
            "name": "Экспресс тяжеловесы С-С",
            "delivery_company_id": 1,
            "type_id": 1
        },
        {
            "id": 16,
            "name": "Экспресс тяжеловесы С-Д",
            "delivery_company_id": 1,
            "type_id": 2
        },
        {
            "id": 17,
            "name": "Экспресс тяжеловесы Д-С",
            "delivery_company_id": 1,
            "type_id": 3
        },
        {
            "id": 18,
            "name": "Экспресс тяжеловесы Д-Д",
            "delivery_company_id": 1,
            "type_id": 4
        },
        {
            "id": 59,
            "name": "Супер-экспресс до 12:00",
            "delivery_company_id": 1,
            "type_id": 2
        },
        {
            "id": 60,
            "name": "Супер-экспресс до 14:00",
            "delivery_company_id": 1,
            "type_id": 2
        },
        {
            "id": 61,
            "name": "Супер-экспресс до 16:00",
            "delivery_company_id": 1,
            "type_id": 2
        },
        {
            "id": 3,
            "name": "Супер-экспресс до 18:00",
            "delivery_company_id": 1,
            "type_id": 2
        },
        {
            "id": 7,
            "name": "Международный экспресс документы",
            "delivery_company_id": 1,
            "type_id": 2
        },
        {
            "id": 8,
            "name": "Международный экспресс грузы",
            "delivery_company_id": 1,
            "type_id": 2
        },
        {
            "id": 1001,
            "name": "Boxberry склад-склад",
            "delivery_company_id": 2,
            "type_id": 1
        },
        {
            "id": 2001,
            "name": "FSDelivery",
            "delivery_company_id": 50,
            "type_id": 4
        },
        {
            "id": 4000,
            "name": "Посылка",
            "delivery_company_id": 55,
            "type_id": 1
        },
        {
            "id": 4001,
            "name": "Посылка онлайн",
            "delivery_company_id": 55,
            "type_id": 1
        },
        {
            "id": 40011,
            "name": "Посылка нестандартная",
            "delivery_company_id": 55,
            "type_id": 1
        },
        {
            "id": 4002,
            "name": "Курьер онлайн",
            "delivery_company_id": 55,
            "type_id": 2
        },
        {
            "id": 4003,
            "name": "Посылка 1 класс",
            "delivery_company_id": 55,
            "type_id": 1
        },
        {
            "id": 4004,
            "name": "Посылка EMS",
            "delivery_company_id": 55,
            "type_id": 2
        },
        {
            "id": 4005,
            "name": "EMS Международное",
            "delivery_company_id": 55,
            "type_id": 2
        },
        {
            "id": 4006,
            "name": "EMS экономичное",
            "delivery_company_id": 55,
            "type_id": 2
        }
    ]
}
            


Есть 4 режима доставки: склад-склад, склад-дверь, дверь-склад, дверь-дверь.
В разных службах доступны разные режимы доставки. Метод позволяет получить 
общий доступный список тарифов и id службы, доставляющей данным тарифом.
Для полного списка отправляется пустой запрос, для сортировки по режиму доставки
в запрос добавляется type_id

{
type_id: 1 // id режима
}

1 - Склад - Склад
2 - Склад - Дверь
3 - Дверь - Склад
4 - Дверь - Дверь




Пример PHP и обработка запроса   

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

В ответ возвращаются возможные статусы заказов как нашей системы, так и каждой службы доставки. В методе получения информации о заказе / о статусах заказа возвращается как внутренний статус системы, так и текущий статус заказа у перевозчика, с текущего списка.

Адрес для запроса
https://api.fsdelivery.ru/1.0/delivery/statuses

Обязательные заголовки в запросе
X-API-TOKEN: ваш токен для авторизации

Передаваемые данные отсутствуют.

Возможные ошибки в ответе

Метод может вернуть только общую ошибку, присущую для любого метода. Типовые ошибки присущие всем методам API указаны в конце документации.

GET

Пример запроса:

{
    // пустой GET запрос на страницу без параметров.
}
           
			
             
Пример ответа :
{
    "request_id": "83055dbe-c633-4b7b-9651-8acbf4fb33b3",
    "status_list": {
        "SystemStatus": { // Внутренние Статусы системы
            "delivery_company_id": 0, // ID курьерской службы к которой относится статус, в данном случае, системные статусы
            "delivery_company_name": "FSDelivery", // Название перевозчика
            "status_list": [
                {
                    "code": 0,
                    "status": "Оформлен",
                    "desc": "Заказ оформлен в нашей системе, но еще не интегрирован в СДЭК. После оплаты заказа статус изменится и вы получите накладную для отправки."
                },
                {
                    "code": 1, // актуален только для клиентов без договора и без системы постоплаты
                    "status": "Оплачен",
                    "desc": "Заказ оплачен и интегрирован с системой СДЭК, его можно отправлять."
                },
                {
                    "code": 2,
                    "status": "В работе",
                    "desc": "Заказ находится в пути, после получения клиентом мы вас уведомим и статус изменится"
                },
                {
                    "code": 3,
                    "status": "Вручен",
                    "desc": "Заказ получен получателем"
                },
                {
                    "code": 4,
                    "status": "Возврат",
                    "desc": "Покупатель отказался от заказа, будет сформирован возврат отправления."
                },
                {
                    "code": 5,
                    "status": "Подготовлен",
                    "desc": "Заказ подготовлен к отправке, накладная сдэк создана, груз можно отправить"
                },
                {
                    "code": 6,
                    "status": "Ожидает оплату",
                    "desc": "Т.к. заказ с оплатой отправителем, его необходимо оплатить. На будущие заказы можно привязать карту для ускорения процесса оплаты или выбрать автоматичческое списание с карты."
                },
                {
                    "code": 7,
                    "satus": "Ошибка",
                    "desc": "Сервер курьерской службы не ответил. Накладная сгенерируется автоматически в ближайшее время."
                },
                {
                    "code": 8,
                    "status": "Оплачен с баланса",
                    "desc": "Заказ оплачен с текущего баланса"
                }
            ]
        },
        "1": { // ID курьерской службы из метода получения списка курьерских служб
            "delivery_company_id": 1, // ID курьерской службы из метода получения списка курьерских служб
            "delivery_company_name": "CDEK", // Название курьерской службы из метода получения списка курьерских служб
            "status_list": {
                "0": {
                    "code": 0,
                    "status": "Неизвестный статус",
                    "desc": ""
                },
                "1": {
                    "code": 1,
                    "status": "Создан",
                    "desc": ""
                },
                "2": {
                    "code": 2,
                    "status": "Удален",
                    "desc": ""
                },
                "3": {
                    "code": 3,
                    "status": "Принят на склад отправителя",
                    "desc": ""
                },
                "6": {
                    "code": 6,
                    "status": "Выдан на отправку в г. отправителе",
                    "desc": ""
                },
                "16": {
                    "code": 16,
                    "status": "Возвращен на склад отправителя",
                    "desc": ""
                },
                "7": {
                    "code": 7,
                    "status": "Сдан перевозчику в г. отправителе",
                    "desc": ""
                },
                "21": {
                    "code": 21,
                    "status": "Отправлен в г. транзит",
                    "desc": ""
                },
                "22": {
                    "code": 22,
                    "status": "Встречен в г. транзите",
                    "desc": ""
                },
                "13": {
                    "code": 13,
                    "status": "Принят на склад транзита",
                    "desc": ""
                },
                "19": {
                    "code": 19,
                    "status": "Выдан на отправку в г. транзите",
                    "desc": ""
                },
                "17": {
                    "code": 17,
                    "status": "Возвращен на склад транзита",
                    "desc": ""
                },
                "20": {
                    "code": 20,
                    "status": "Сдан перевозчику в г. транзите",
                    "desc": ""
                },
                "8": {
                    "code": 8,
                    "status": "Отправлен в г. получатель",
                    "desc": ""
                },
                "9": {
                    "code": 9,
                    "status": "Встречен в г. получателе",
                    "desc": ""
                },
                "10": {
                    "code": 10,
                    "status": "Принят на склад доставки",
                    "desc": ""
                },
                "12": {
                    "code": 12,
                    "status": "Принят на склад до востребования",
                    "desc": ""
                },
                "11": {
                    "code": 11,
                    "status": "Выдан на доставку",
                    "desc": ""
                },
                "18": {
                    "code": 18,
                    "status": "Возвращен на склад доставки",
                    "desc": ""
                },
                "4": {
                    "code": 4,
                    "status": "Вручен",
                    "desc": ""
                },
                "5": {
                    "code": 5,
                    "status": "Не вручен",
                    "desc": ""
                }
            }
        },
        "2": { // ID курьерской службы из метода получения списка курьерских служб
            "delivery_company_id": 2, // ID курьерской службы из метода получения списка курьерских служб
            "delivery_company_name": "BoxBerry", // Название курьерской службы из метода получения списка курьерских служб
            "status_list": {
                "0": {
                    "code": 0,
                    "status": "Загружен реестр ИМ",
                    "desc": "Заказ загружен в ИС Боксберри (сформирован акт boxberry для отправки посылки)"
                },
                "1": {
                    "code": 1,
                    "status": "Принято к доставке",
                    "desc": "Груз промаркирован и принят на складе Боксберри."
                },
                "2": {
                    "code": 2,
                    "status": "Передано на сортировку",
                    "desc": "Заказ готовится к отправке в город назначения."
                },
                "3": {
                    "code": 3,
                    "status": "Отправлен на сортировочный терминал",
                    "desc": "В пути на терминал."
                },
                "6": {
                    "code": 6,
                    "status": "Отправлено в город назначения",
                    "desc": "Груз фактически отправлен в город назначения."
                },
                "16": {
                    "code": 16,
                    "status": "Передан на доставку до пункта выдачи",
                    "desc": "Отправлен в пункт выдачи."
                },
                "7": {
                    "code": 7,
                    "status": "Передано на курьерскую доставку",
                    "desc": "Заказ прибыл в город назначения, с получателем согласовано время доставки. Заказ передан курьеру"
                },
                "21": {
                    "code": 21,
                    "status": "Поступило в пункт выдачи",
                    "desc": "Заказ поступил в пункт выдачи. Готов к получению."
                },
                "22": {
                    "code": 22,
                    "status": "Выдано",
                    "desc": "Заказ выдан получателю."
                },
                "13": {
                    "code": 13,
                    "status": "Возвращено с курьерской доставки",
                    "desc": "Заказ возвращен с курьерской доставки"
                },
                "19": {
                    "code": 19,
                    "status": "Готовится к возврату",
                    "desc": "Заказ готовится на возврат, но по факту находятся в пункте выдачи."
                },
                "17": {
                    "code": 17,
                    "status": "Отправлено в пункт приема",
                    "desc": "Заказ отправлен на возврат."
                },
                "20": {
                    "code": 20,
                    "status": "Возвращено в пункт приема",
                    "desc": "Заказ поступил на склад возвратов Боксберри."
                },
                "8": {
                    "code": 8,
                    "status": "Возвращено в ИМ",
                    "desc": "Заказ отправлен в интернет-магазин"
                }
            }
        }
    }
}
            

Метод возвращает возможные статусы заказа. Метод справочный и не 
относится к конкретному заказу ( заказам ). Есть два вида статусов: Статус заказа в системе FsDelivery и статус заказа по версии курьерской службы. Метод возвращает все возможные варианты внутренних статусов FsDelivery и статусов служб доставки, а так же дополнительных статусов заказа. Например: Статус в системе: В работе Статус сдэк: Не вручен Доп статус сдэк: Истёк срок хранения

Пример PHP


   

Получение списка стран

Для получения списка стран по базе FsDelivery необходимо отправить POST запрос к серверу FsDelivery. Если входные параметры не указаны, ответ будет содержать полный список стран с имеющийся информацией о стране. При передаче json-объекта в заголовке нужно указать соответствующий Content-Type :

Адрес для запроса
https://api.fsdelivery.ru/1.0/reference/countries

Обязательные заголовки в запросе
X-API-TOKEN: ваш токен для авторизации

Описание передаваемых данных

Параметр Тип Описание
country_id int ID страны по базе FsDelivery.ru
country_code String Код страны (ISO 3166-1 2 буквы)
country_name String Точное название страны ( например Россия ), поиск без учета регистра

Возможные ошибки в ответе

Типовые ошибки присущие всем методам API указаны в конце документации. Ниже список ошибок, которые может вернуть метод, помимо общих ошибок, присущих всем методам.

ID Сообщение
30006 По заданным параметрам страны не найдены. Уменьшите количество передаваемых данных в запросе.
POST
 
Пример запроса:

{
    "country_id": 2,
    "country_name": "РОССИЯ" // игнорируется, т.к. передан параметр country_id
}
          
             
Пример ответа :

{
   "request_id": "8f48a671-24ba-4298-9940-0141f2062577",
   "country_list": [   {
      "id": 2,
      "name": "Австрия",
      "name_eng": "Austria",
      "code": "AT" 
   }]
}

Ещё один пример запроса:

{
    "country_name": "РОССИЯ" // Регистр не важен 
}
            
Ещё один пример ответа :

{
    "request_id": "d2477321-9d0c-4afb-b422-e5e08972d242",
    "country_list": [
        {
            "id": 1,
            "name": "Россия",
            "name_eng": "Russia",
            "code": "RU"
        }
    ]
}
            
			Метод позволяет получить ID стран в системе FsDelivery.
Это может пригодиться, например, для заказов с наложенным платежом или
с оплатой за доставку. Приём денег с получателей есть только в России и Казахстане, получив ID этих стран можно более детально настсроить работу по API.
			Пример PHP
			
			

Получение списка городов

Для получения справочника городов, необходимо отправить json-объект серверу FsDelivery.

Адрес для запроса
https://api.fsdelivery.ru/1.0/reference/cities

Обязательные заголовки в запросе
X-API-TOKEN: ваш токен для авторизации

Описание передаваемых данных

Параметр Тип Описание
fsdelivery_city_id int ID города по базе FSDelivery
kladr_id String Код города по КЛАДР
fias_id string код города по ФИАС
postal_code int Почтовый индекс города
country_iso_code string код страны (ISO 3166-1 2 буквы )
page_number int Номер страницы для выборки
page_size int Количество результатов на странице

Возможные ошибки в ответе

Список ошибок, присущий методу получения списка городов. Общий список ошибок расположен в конце документации.

ID Ошибки Описание
30005 По заданным параметрам города не найдены
POST

Пример запроса:

{
    "kladr_id": "7700000003300",
    "country_iso_code": "RU",
    "page_number": 1,
    "page_size": 100
}
          
         
			  
Пример ответа:

{
    "request_id": "2d7f4660-e73e-45a5-a6cd-737341c28f8d",
    "city_list": [
        {
            "id": "1383",
            "kladr_id": "1383",
            "fias_id": "1383",
            "postal_code": "108809",
            "name": "Россия",
            "name_only": "Толстопальцево пос.",
            "fullname": "ТОЛСТОПАЛЬЦЕВО ПОС., МОСКВА",
            "name_eng": "Russia",
            "region": "Москва",
            "country_iso": "RU",
            "country_id": "1",
            "country_name": "Россия",
            "country_name_eng": "Russia",
            "last_date_update": "2019-11-21"
        }
    ],
    "page_number": 1,
    "page_size": 100
}

Пример запроса:

{
    "postal_code": "127282"
}


Пример ответа:

{
    "request_id": "ab2ab520-0992-46e2-a0e3-1bf5627da37e",
    "city_list": [
        {
            "id": "44",
            "kladr_id": "7700000000000",
            "fias_id": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
            "postal_code": null,
            "name": "Россия",
            "name_only": "Москва",
            "fullname": "МОСКВА",
            "name_eng": "Russia",
            "region": "Москва",
            "country_iso": "RU",
            "country_id": "1",
            "country_name": "Россия",
            "country_name_eng": "Russia",
            "last_date_update": "2021-03-21"
        }
    ]
}
            
			Данный метод позволяет получить город или списки городов по базе FsDelivery с различными способами идентифицикации:
			id,kladr_id,fias_id,postal_code
			Пример PHP
			
			

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

Получение информации о городах по буквам. Минимальное количество букв в запросе - две. В ответ сервер выдаст полную информацию о найденных городах по заданным буквам в запросе. Ответ аналогичен ответу из метода /reference/cities

Адрес для запроса
https://api.fsdelivery.ru/1.0/reference/cities/autocomplete

Обязательные заголовки в запросе
X-API-TOKEN: ваш токен для авторизации

Описание передаваемых данных

Параметр Тип Описание
char_city_name * string Строка поиска по названию города (от двух символов)
fsdelivery_country_id int id страны в FSDelivery

Возможные ошибки в ответе

Список ошибок, присущий методу получения списка городов. Общий список ошибок расположен в конце документации.

ID Ошибки Описание
10009 Длина параметра char_city_name должна быть не меньше 2.
В случае отсутствия городов в ответе - возвращается пустой массив.
POST

Пример запроса:

{
    "char_city_name": "Толь",
    "fsdelivery_country_id": "1" 
}

         
			  
Пример ответа:

{
    "request_id": "5ed7c07b-ffe9-48da-af40-e6da324e9b17",
    "city_list": [
        {
            "id": "431",
            "kladr_id": "431",
            "fias_id": "431",
            "postal_code": null,
            "name": "Россия",
            "name_only": "Тольятти",
            "fullname": "ТОЛЬЯТТИ",
            "name_eng": "Russia",
            "region": "Самарская обл.",
            "country_iso": "RU",
            "country_id": "1",
            "country_name": "Россия",
            "country_name_eng": "Russia",
            "last_date_update": "2019-11-21"
        },
        {
            "id": "13150",
            "kladr_id": "13150",
            "fias_id": "13150",
            "postal_code": null,
            "name": "Россия",
            "name_only": "Толька",
            "fullname": "ТОЛЬКА, ЯМАЛО-НЕНЕЦКИЙ АВТ. ОКРУГ",
            "name_eng": "Russia",
            "region": "Ямало-Ненецкий авт. округ",
            "country_iso": "RU",
            "country_id": "1",
            "country_name": "Россия",
            "country_name_eng": "Russia",
            "last_date_update": "2019-11-21"
        },
        {
            "id": "31362",
            "kladr_id": "31362",
            "fias_id": "31362",
            "postal_code": null,
            "name": "Россия",
            "name_only": "Бристоль",
            "fullname": null,
            "name_eng": "Russia",
            "region": "Московская обл.",
            "country_iso": "RU",
            "country_id": "1",
            "country_name": "Россия",
            "country_name_eng": "Russia",
            "last_date_update": "2019-11-21"
        },
        {
            "id": "46360",
            "kladr_id": "46360",
            "fias_id": "46360",
            "postal_code": null,
            "name": "Россия",
            "name_only": "Тольен, Дебесский р-н",
            "fullname": null,
            "name_eng": "Russia",
            "region": "Удмуртия респ.",
            "country_iso": "RU",
            "country_id": "1",
            "country_name": "Россия",
            "country_name_eng": "Russia",
            "last_date_update": "2019-11-21"
        },
        {
            "id": "52399",
            "kladr_id": "52399",
            "fias_id": "52399",
            "postal_code": null,
            "name": "Россия",
            "name_only": "Стольное, Одинцовский р-н",
            "fullname": null,
            "name_eng": "Russia",
            "region": "Московская обл.",
            "country_iso": "RU",
            "country_id": "1",
            "country_name": "Россия",
            "country_name_eng": "Russia",
            "last_date_update": "2019-11-21"
        }
    ]
}
            

Метод используется преимущественно на сайтах в месте ввода города 
клиентом, когда используется база городов FsDelivery.
По вводу букв в запрос в ответ возвращаются найденные города с полной
информацией о городе, необходимой для дальнейших действий с данными,
например, найти ПВЗ или обратиться к калькулятору за тарифами.

Пример PHP

Получение списка ПВЗ

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

Адрес для запроса
https://api.fsdelivery.ru/1.0/delivery/points

Обязательные заголовки в запросе
X-API-TOKEN: ваш токен для авторизации

Описание передаваемых данных

Параметр Тип Описание
fsdelivery_city_id int ID города по базе FsDelivery из метода получения списка городов
fsdelivery_country_id int ID страны по базе FsDelivery из метода получения списка стран
country_iso_code string ISO код страны по базе FsDelivery из метода получения списка стран
delivery_company_id int ID курьерской службы по базе FsDelivery из метода получения списка курьерских служб
kladr_id int КЛАДР ID города по общепринятым стандартам
fias_id int ФИАС ID города по общепринятым стандартам
postal_code int ИНДЕКС города по общепринятым стандартам

Возможные ошибки в ответе

Список ошибок, присущий методу получения списка городов. Общий список ошибок расположен в конце документации.

ID Ошибки Описание
10009 Длина параметра char_city_name должна быть не меньше 2.
В случае отсутствия городов в ответе - возвращается пустой массив.
POST

Пример запроса:

{
    "fsdelivery_city_id": 366
}

        
			  
Пример ответа:

{
    "1": [
        {
            "delivery_company_id": 1,
            "delivery_company_name": "Cdek",
            "coord_x": "39.734677",
            "coord_y": "52.043796",
            "country_id": "1",
            "city_id": "366",
            "city_name": "Усмань",
            "city_kladr": "4801600100000",
            "city_fias": "1b3ce1ae-6edd-464b-ab82-79237510cd5c",
            "postal_code": null,
            "address": "ул. Воеводы Вельяминова, 47",
            "full_address": "Россия, Липецкая обл., Усмань, ул. Воеводы Вельяминова, 47",
            "address_comment": "От остановки «Площадь Ленина» 100 м в сторону площади Ленина, угловой магазин «Центральный».",
            "schedule": "[{\"day\":\"1\",\"periods\":\"10:00\\/19:00\"},{\"day\":\"2\",\"periods\":\"10:00\\/19:00\"},{\"day\":\"3\",\"periods\":\"10:00\\/19:00\"},{\"day\":\"4\",\"periods\":\"10:00\\/19:00\"},{\"day\":\"5\",\"periods\":\"10:00\\/19:00\"},{\"day\":\"6\",\"periods\":\"10:00\\/16:00\"}]",
            "metro": "",
            "is_cash": 1,
            "phone": "[{\"number\":\"+79803532088\"}]"
        }
    ],
    "2": [
        {
            "delivery_company_id": 2,
            "delivery_company_name": "Boxberry",
            "coord_x": "39.737066",
            "coord_y": "52.040505",
            "country_id": "1",
            "city_id": "366",
            "city_name": "Усмань",
            "city_kladr": "4801600100000",
            "city_fias": "1b3ce1ae-6edd-464b-ab82-79237510cd5c",
            "postal_code": null,
            "address": "Ленина ул, д.12",
            "address_comment": "Остановка - Аграрный колледж.\nПримерное расстояние от остановки до Отделения - 300 м.\n2-этажный нежилой дом.\n1 этаж.\nВход в улицы, единственная дверь с левого края здания.\nОфис \"Изготовление печатей\".\n\n",
            "schedule": "[{\"day\":1,\"periods\":\"10:00\\/19:00\",\"lunch\":\"\\/\"},{\"day\":2,\"periods\":\"10:00\\/19:00\",\"lunch\":\"\\/\"},{\"day\":3,\"periods\":\"10:00\\/19:00\",\"lunch\":\"\\/\"},{\"day\":4,\"periods\":\"10:00\\/19:00\",\"lunch\":\"\\/\"},{\"day\":5,\"periods\":\"10:00\\/19:00\",\"lunch\":\"\\/\"},{\"day\":6,\"periods\":\"10:00\\/16:00\",\"lunch\":\"\\/\"},{\"day\":7,\"periods\":\"\\/\",\"lunch\":\"\\/\"}]",
            "metro": "",
            "is_cash": 1,
            "phone": "8-800-222-80-00"
        }
    ]
}

            

Город идентифицируется по одному из следующих параметров в запросе:

fsdelivery_city_id - ID города в таблице api_cities
kladr_id // Кладр города
fias_id // FIAS города
postal_code // индекс города

В случае передачи fsdelivery_city_id, параметры kladr_id,fias_id,postal_code - игнорируются.

Возможность фильтрации:
fsdelivery_country_id // ID страны из справочника стран
country_iso_code // ISO код страны из справочника стран


  

Пример PHP

  

Получение информации по заказам

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

Адрес для запроса
https://api.fsdelivery.ru/1.0/order/find

Обязательные заголовки в запросе
X-API-TOKEN: ваш токен для авторизации

Описание передаваемых данных

Параметр Тип Описание
order_id int ID заказа по базе FsDelivery
order_number string Внутренний номер заказа интернет-магазина
dispacher_number string Номер накладной / трекинг номер в курьерской службе
create_date date Дата создания заказа в формате Y-m-d ( это дата создания накладной в курьерской службе, а не дата создания заказа в системе )
delivery_date date Дата вручения заказа
sender_city_name string Город отправителя по базе FsDelivery с метода получения списка городов. Например: Екатеринбург
reciver_city_name string Город получателя по базе FsDelivery с метода получения списка городов. Например: Казань
reciver_name string Имя получателя, как оно записано в заказе или заказах, поиск ведется по точному соответствию.
reciver_phone string Телефон получателя, как он записан в заказе или заказах. Не стандантизируется, поиск ведется по точному соответствию.
tariff_id int ID тарифа по базе FsDelivery с метода получения списка тарифов.
send_date date Дата приезда курьера для заказов от двери
type_id int Тип заказа с метода получения типов заказа ( число от 1 до 4 )

Возможные ошибки в ответе

Типовые ошибки присущие всем методам API указаны в конце документации. Ниже список ошибок, которые может вернуть метод, помимо общих ошибок, присущих всем методам.

ID Сообщение
10007 Параметр %s должен состоять только из цифр
10009 Длина параметра char_city_name должна быть не меньше 2.
10012 Количество элементов в параметре %s не должно превышать %d
10012 Количество элементов в параметре %s не должно превышать %d
10014 Не верная дата в параметре %s. Должны быть заполнены вложенные параметры %s
POST

Пример запроса:

{
    "order_id": [358,382]
	// в примере получение заказов по двум ID
}

        
			  
Пример ответа:

{
   "request_id": "687f4f38-586e-4047-a593-34096dc72e9b",
   "orders":    [
            {
         "order_id": "358",
         "order_number": "",
         "order_dispacher_number": "трек_номер",
         "creation_time": "2019-02-06 17:12:21",
         "dispacher_date": "2019-02-06 05:12:35",
         "type_id": "2",
         "service_id": "1",
         "last_status_id": "3",
         "last_status_delivery_company_id": "0",
         "last_status_delivery_company_date": null,
         "last_status_delivery_company_city_name": null,
         "dop_last_status_id": null,
         "item_count": "1",
         "tariff_id": "11",
         "tariff_name": "Экспресс лайт склад-дверь",
         "sender_city_id": "44",
         "sender_city_name": "Москва",
         "sender_flat": "",
         "sender_house": "",
         "sender_comment": "",
         "reciver_country_id": "0",
         "reciver_city_id": "44",
         "reciver_city_name": "Москва",
         "reciver_email": "",
         "pvz_id": null,
         "pvz_name": null,
         "reciver_name": "Стратегия",
         "reciver_phone": "+7 (495) 000-00-00",
         "reciver_phone2": null,
         "reciver_phone3": null,
         "reciver_street": "Жуковского",
         "reciver_home": "5",
         "reciver_ofice": "14",
         "reciver_comment": "Комментарий к получателю",
         "shop_name": "-",
         "total_sum": "0.00",
         "courier_number": null,
         "delivery_recipient_payment": "0.00",
         "delivery_recipient_payment_fact": "0",
         "total_recipient_payment": "0.00",
         "total_recipient_payment_fact": "0.00",
         "min_period": null,
         "max_period": null,
         "is_return": "0",
         "returned_dispacher_number": "0",
         "np_pereveden": "0",
         "max_date_storage": null,
         "act_number": "1",
         "reestr_user_number": null,
         "reestr_in_order_date": null,
         "courier_delivered_phone_name": "",
         "prices":          [
                        {
               "cost": "220",
               "type_id": "1" 
            },
                        {
               "cost": "0.75",
               "type_id": "2" 
            }
         ],
         "items": [         {
            "weight": "0.5",
            "height": "0",
            "width": "0",
            "length": "0",
            "total": "0.00",
            "insurance": "1.00",
            "name": "",
            "payment": null
         }]
      },
            {
         "order_id": "382",
         "order_number": "",
         "order_dispacher_number": "трек_номер",
         "creation_time": "2019-02-07 13:02:21",
         "dispacher_date": "2019-02-07 01:02:22",
         "type_id": "1",
         "service_id": "1",
         "last_status_id": "3",
         "last_status_delivery_company_id": "0",
         "last_status_delivery_company_date": null,
         "last_status_delivery_company_city_name": null,
         "dop_last_status_id": null,
         "item_count": "1",
         "tariff_id": "136",
         "tariff_name": "Посылка склад-склад",
         "sender_city_id": "44",
         "sender_city_name": "Москва",
         "sender_flat": "",
         "sender_house": "",
         "sender_comment": "",
         "reciver_country_id": "0",
         "reciver_city_id": "137",
         "reciver_city_name": "Санкт-Петербург",
         "reciver_email": "",
         "pvz_id": "SPB24",
         "pvz_name": "На Гагарина (пр-т Юрия Гагарина, 2 корп.3)",
         "reciver_name": "Степан",
         "reciver_phone": "+7 (495) 000-00-00",
         "reciver_phone2": null,
         "reciver_phone3": null,
         "reciver_street": "",
         "reciver_home": "",
         "reciver_ofice": "",
         "reciver_comment": "Луи. ",
         "shop_name": "",
         "total_sum": "0.00",
         "courier_number": null,
         "delivery_recipient_payment": "0.00",
         "delivery_recipient_payment_fact": "0",
         "total_recipient_payment": "0.00",
         "total_recipient_payment_fact": "0.00",
         "min_period": null,
         "max_period": null,
         "is_return": "0",
         "returned_dispacher_number": "0",
         "np_pereveden": "0",
         "max_date_storage": null,
         "act_number": "1",
         "reestr_user_number": null,
         "reestr_in_order_date": null,
         "courier_delivered_phone_name": "",
         "prices":          [
                        {
               "cost": "187",
               "type_id": "1" 
            },
                        {
               "cost": "0.75",
               "type_id": "2" 
            },
                        {
               "cost": "37.55",
               "type_id": "200" 
            }
         ],
         "items": [         {
            "weight": "0.5",
            "height": "0",
            "width": "0",
            "length": "0",
            "total": "0.00",
            "insurance": "1.00",
            "name": "",
            "payment": null
         }]
      }
   ]
}
            

FAQ


Пример PHP

Получение статусов заказа

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

Адрес для запроса
https://api.fsdelivery.ru/1.0/order/statuses

Обязательные заголовки в запросе
X-API-TOKEN: ваш токен для авторизации

Описание передаваемых данных

Параметр Тип Описание
order_id int ID заказа по базе FsDelivery
order_number string Внутренний номер заказа интернет-магазина
dispacher_number string Номер накладной / трекинг номер в курьерской службе
show_history int Загружать ли историю статусов заказа ( 0 - нет, 1 - да )

Возможные ошибки в ответе

Типовые ошибки присущие всем методам API указаны в конце документации. Ниже список ошибок, которые может вернуть метод, помимо общих ошибок, присущих всем методам.

ID Сообщение
10007 Параметр %s должен состоять только из цифр
10012 Количество элементов в параметре %s не должно превышать %d
10013 В запросе должен быть указан один из обязательных параметров %s
10015 По заданным параметрам заказы не найдены
POST

Пример запроса:

{
    "order_id": [358,382]
	// в примере получение заказов по двум ID
}

      
			  
Пример ответа:

{
   "request_id": "294e0fa6-c528-47ec-9c4e-42c48a19e86b",
   "orders":    [
            {
         "order_id": "358",
         "order_number": "",
         "order_dispacher_number": "1108697266",
         "order_delivery_copmany_id": "1",
         "city_name": null,
         "delivery_status_id": "0",
         "delivery_status_date": null,
         "delivery_status_name": "Неизвестный статус",
         "delivery_status_description": "",
         "status_list":          [
                        {
               "id": "329",
               "order_id": "358",
               "status_id": "0",
               "date": "2019-02-06 17:12:21" 
            },
                        {
               "id": "330",
               "order_id": "358",
               "status_id": "6",
               "date": "2019-02-06 17:12:21" 
            },
                        {
               "id": "331",
               "order_id": "358",
               "status_id": "1",
               "date": "2019-02-06 05:12:35" 
            },
                        {
               "id": "410",
               "order_id": "358",
               "status_id": "3",
               "date": "2019-02-07 21:34:53" 
            }
         ]
      },
            {
         "order_id": "382",
         "order_number": "",
         "order_dispacher_number": "1108793811",
         "order_delivery_copmany_id": "1",
         "city_name": null,
         "delivery_status_id": "0",
         "delivery_status_date": null,
         "delivery_status_name": "Неизвестный статус",
         "delivery_status_description": "",
         "status_list":          [
                        {
               "id": "376",
               "order_id": "382",
               "status_id": "0",
               "date": "2019-02-07 13:02:22" 
            },
                        {
               "id": "377",
               "order_id": "382",
               "status_id": "5",
               "date": "2019-02-07 13:02:22" 
            },
                        {
               "id": "597",
               "order_id": "382",
               "status_id": "2",
               "date": "2019-02-10 12:37:21" 
            },
                        {
               "id": "669",
               "order_id": "382",
               "status_id": "3",
               "date": "2019-02-11 23:11:47" 
            }
         ]
      }
   ]
}
               

FAQ


Пример PHP

Список реестров НП

Метод позволяет получить список реестров наложенных платежей и подробную информацию о содержании реестра. Данный метод выдает информацию по реестрам, но не содержит список накладных, входящих в реестр. Получить список накладных для нужного реестра можно в методе /1.0/reestr/waybills

Адрес для запроса
https://api.fsdelivery.ru/1.0/reestr/list

Обязательные заголовки в запросе
X-API-TOKEN: ваш токен для авторизации

Описание передаваемых данных

Параметр Тип Описание
status_id int ID статуса реестра из метода /1.0/reference/reestr/statuses
reestr_number int Фильтрация по номеру реестра ( в ответе в поле number из текущего метода )
created_date date Фильтрация по дата реестра
payment_plan_date date Фильтрация по дате планируемой оплаты реестра ( поле payment_plan_date в ответе из текущего метода )
payment_date date Фильтрация по дате оплаты реестра ( поле payment_date в ответе из текущего метода )

Возможные ошибки в ответе

Список ошибок, присущий методу получения списка городов. Общий список ошибок расположен в конце документации.

ID Ошибки Описание
10007 Параметр %s должен состоять только из цифр
В случае отсутствия городов в ответе - возвращается пустой массив.
POST

Пример запроса:
{
"created_date": "2019-12-30"
}


			  
Пример ответа:

{
   "request_id": "cb95896d-c1a1-4a62-b98c-ef4bd6da8e95",
   "reestr_list": [   {
      "number": "1",
      "status_id": "0",
      "status_name": "Готовится",
      "order_count": "0",
      "sum_for_payment": "0.00",
      "payment_plan_date": "",
      "payment_date": "",
      "bank_pp": "",
      "deilvery_sum": "0.00",
      "agent_sum": "0.00",
      "np": "0.00",
      "history": [      {
         "id": "43",
         "reestr_id": "61",
         "status_id": "0",
         "change_date": "2019-12-30 17:45:05",
         "user_id": "0",
         "status_name": "Готовится" 
      }]
   }]
}

             

FAQ


Пример PHP

Детализация по реестру НП

Метод позволяет получить список реестров наложенных платежей и подробную информацию о содержании реестра. Данный метод выдает информацию по реестрам, но не содержит список накладных, входящих в реестр. Получить список накладных для нужного реестра можно в методе /1.0/reestr/waybills

Адрес для запроса
https://api.fsdelivery.ru/1.0/reestr/waybills

Обязательные заголовки в запросе
X-API-TOKEN: ваш токен для авторизации

Описание передаваемых данных

Параметр Тип Описание
reestr_number int Номер реестра наложенного платежа ( поле number из метода /1.0/reestr/list )

Возможные ошибки в ответе

Список ошибок, присущий методу получения списка городов. Общий список ошибок расположен в конце документации.

POST

Пример запроса:

{
    "reestr_number": 1
}

        
			  
Пример ответа:

{
   "request_id": "841f06bd-55b7-4f31-b8ff-34c564639d23",
   "waybills": {"61": [   {
      "delivery_company_id": "1",
      "order_num": null,
      "dispacher_number": "1152922965",
      "dispacher_date": "2019-12-13 12:44:17",
      "delivery_date": "2019-12-18 18:43:00",
      "delivery_sum": "990.75",
      "agent_sum": "660.00",
      "np": "22000.00" 
   }]}
}

    

FAQ


Пример PHP

Статусы реестров НП

Оплата наложенных платежей производится по реестрам. Метод возвращает возможные статусы реестров в нашей системе. Метод не предназначен для получения текущих реестров пользователя, а лишь возвращает фиксированный список, который не будет изменён в будущем.

Адрес для запроса
https://api.fsdelivery.ru/1.0/reference/reestr/statuses

Обязательные заголовки в запросе
X-API-TOKEN: ваш токен для авторизации

Описание передаваемых данных

Передаваемые параметры отсутствуют

Возможные ошибки в ответе

Список ошибок, присущий методу получения списка городов. Общий список ошибок расположен в конце документации.

POST

Пример запроса:

{
    // пустой запрос
}

			  
Пример ответа:

{
   "request_id": "04f090f8-f3d2-4beb-b2ca-4c96e5d3c01a",
   "status_list":    [
            {
         "name": "Готовится",
         "id": 0
      },
            {
         "name": "К оплате",
         "id": 1
      },
            {
         "name": "В графике",
         "id": 2
      },
            {
         "name": "Оплачен",
         "id": 3
      },
            {
         "name": "Удален",
         "id": 4
      }
   ]
}

             

FAQ


Пример PHP

Получение информации о пользователе

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

Адрес для запроса
https://api.fsdelivery.ru/1.0/user/info

Обязательные заголовки в запросе
X-API-TOKEN: ваш токен для авторизации

Описание передаваемых данных

Передаваемые параметры отсутствуют

Возможные ошибки в ответе

ID Ошибки Описание
30008 Отсутствуют настроки пользователя в системе FSDelivery
В случае отсутствия городов в ответе - возвращается пустой массив.
GET

Пример запроса:

{
// пустой запрос с Api Token
}


			  
Пример ответа:
{
   "request_id": "2097a8fe-cb41-412f-b8ee-c2578ae7cba5",
   "username": "Егор",
   "phone": "+78000000000",
   "link": "http://wrds1.ru",
   "email": "info@masil.ru",
   "dogovor": true,
   "city_name": "",
   "city_id": null,
   "shop_name": null,
   "balance": -24683.5,
   "real_balance": -21817.7,
   "cdek_on": true,
   "boxberry_on": false,
   "cse_on": false,
   "iml_on": false,
   "dellin_on": false,
   "ruspost_on": false,
   "fastdo_on": false,
   "inn": null,
   "kpp": null,
   "ogrn": null,
   "okved": null,
   "status_company_ur": null,
   "reg_data": null,
   "ur_adress": null,
   "director_name": null,
   "director_post_name": null,
   "bank_name": null,
   "bik": null,
   "correspondent_account": null,
   "checking_account": null,
   "opf": null,
   "name_ooo": null,
   "agent_sum": 3,
   "signature_basis": null,
   "signature_basis_date": null,
   "signature_basis_serial": null,
   "signature_basis_number": null,
   "settings":    {
      "default_item_name": "Заказ",
      "default_sender_phone": "88000000000",
      "default_sender_street": "",
      "default_sender_email": "info@masil.ru",
      "default_sender_shop_name": "-",
      "default_sender_name": "Шаген",
      "default_sender_comment": "",
      "default_sender_city_id": 44,
      "default_sender_city": "Москва",
      "default_insecury": "1",
      "default_insecury_sum": "1",
      "default_sender_house": null,
      "default_sender_flat": null,
      "send_to_email_create": false,
      "send_to_email_work": false,
      "send_to_email_dd": false,
      "send_to_pdf_work": false,
      "send_to_pdf_create": false,
      "more_paymenter": true,
      "copy_count": true,
      "boxberry_pvz_sender_id": null,
      "boxberry_pvz_sender_name": null,
      "OrderNum": false,
      "from_door": false
   }
}

   

FAQ


Пример PHP

Обновление информации о пользователе

Обновление данных профиля, настроек по умолчанию

Адрес для запроса
https://api.fsdelivery.ru/1.0/user/info

Обязательные заголовки в запросе
X-API-TOKEN: ваш токен для авторизации

Описание передаваемых данных

Параметр Тип Описание
cdek_on int Включить / отключить службу СДЭК
boxberry_on int Включить / отключить службу Boxberry
cse_on int Включить / отключить службу CSE
iml_on int Включить / отключить службу IML
dellin_on int Включить / отключить службу Деловые линии
ruspost_on int Включить / отключить службу Почта России
fastdo_on int Включить / отключить службу FastDo
fsdelivery_on int Включить / отключить службу FsDelivery
Блок Setting {}
Параметр Тип Описание
boxberry_pvz_sender_id int ID ПВЗ отправителя Boxberry
OrderNum int / boolean Использовать внутренние номера заказов ( 0 - нет, 1 - да ) или false / true
from_door int / boolean Заказы чаще от двери ( 1 - да, 0 - нет ) или true / false
default_item_name string Наименование товара по умолчанию
default_insecury_sum string Сумма страхования по умолчанию
default_sender_city_id string ID города отправителя по умолчанию ( по базе FsDelivery, с метода получения городов )
default_sender_name string Имя / ФИО отправителя по умолчанию
default_sender_phone string Номер телефона отправителя по умолчанию
default_sender_street string Улица отправителя по умолчанию
default_sender_house string Номер дома отправителя по умолчанию
default_sender_flat string Номер квартиры / офиса отправителя по умолчанию
default_sender_comment string Комментарий к отправителю по умолчанию
send_to_email_create int Отправлять получателю email письмо при создании заказа ( 1 - да, 0 - нет ) или true / false
send_to_email_work int Отправлять получателю email письмо когда заказ фактически передается в службу доставки ( 1 - да, 0 - нет ) или true / false
send_to_email_dd int Отправлять получателю email письмо когда заказ получает статус вручен ( 1 - да, 0 - нет ) или true / false
send_to_pdf_work int Вложить накладную PDF в письмо когда заказ фактически передается в службу доставки ( 1 - да, 0 - нет ) или true / false
send_to_pdf_create int Вложить накладную PDF в письмо когда заказ создается ( 1 - да, 0 - нет ) или true / false

Возможные ошибки в ответе

ID Ошибки Описание
10019 Параметр %s может принимать значения 0, 1, false или true
10020 Длина параметра %s должна быть не больше %d
10021 В запросе в параметре %s присутствуют некорректные параметры: %s
10022 Параметр %s должен быть массивом
POST

Пример запроса:

{
// пустой запрос с Api Token
}

			  
Пример ответа:





FAQ


Пример PHP

Стандартные ошибки для всех методов

Полный список ошибок, которые можно получить в ответе от сервера FsDelivery. Кроме фиксированного списка для каждого метода описаны отдельные варианты ошибок, присущих только конкретному методу.

Возможные ошибки в ответе

Типовые ошибки присущие всем методам API

ID Сообщение
10001 Не передан ID пользователя. За дополнительной информацией неободимо обратиться на api@fsdelivery.ru, либо получить в методе регистрации пользователя через API / модуль.
10004 В запросе присутствуют некорректные параметры: param1, param2, param3, которые не должны передаваться в методе.
30001 Не передан токен. Токен можно выпустить в личном кабинете или запросить по email api@fsdelivery.ru, либо получить в методе регистрации пользователя через API / модуль.
30003 Ошибочный токен. Переданный токен не соответствует токену FsDelivery.ru
30003 Срок действия токена истек. Токен обычно имеет бесконечный срок действия. При получении данной ошибки обратитесь на api@fsdelivery.ru для разрешения проблемы.
30004 Издатель токена не найден. При получении данной ошибки обратитесь на api@fsdelivery.ru для разрешения проблемы.
30007 Аккаунт заблокирован. Для решения данной проблемы необходимо обратиться к персональному менеджеру или оставить запрос на info@fsdelvery.ru
30100 Синтаксическая ошибка в JSON запросе.
30101 Запрос должен быть в формате JSON.
30102 Запрос должен быть в кодировке UTF-8. Многобайтовые символы должны быть преобразованы в Unicode.
30103 Обнаружен бесконечный цикл в преобразуемом объекте. Проверьте корректность JSON запроса.
30104 Имя свойства не может быть закодировано в JSON запросе.
50000 Внутренняя ошибка сервиса. Просим сообщить любую информацию о запросе на api@fsdelivery.ru. Ошибка может возникать и в случаях, независящих от сервера FsDelivery.
50002 Вызываемый функция не поддерживает переданный метод запроса. Попробуйте метод: POST . Ожидаем POST запрос, GET запрос выдаст ошибку 50002 и наоборот.
50002 Вызываемый функция не поддерживает переданный метод запроса. Попробуйте метод: POST . Ожидаем POST запрос, GET запрос выдаст ошибку 50002 и наоборот.
50001 Вызываемая функция отсутствует в API Просим. сообщить любую информацию о запросе на api@fsdelivery.ru если считаете что запрос верный.