Добавление нового ПВЗ в существующий справочник

Метод используется для добавления новой точки выдачи любого допустимого типа, в справочник ПВЗ, созданный на стороне ИС Золотого Яблока. Причиной добавления может послужить открытие новой точки, подключение точек партнёров курьерской службы и любые другие события связанные с предоставлением новых точек выдачи.

Основная информация

Тип метода запроса	POST
Путь/URL	/api/v1/pickpoints/add
Описание	Метод для добавления одного ПВЗ в справочник, сохранённый на стороне ИС ЗЯ. Один запрос - один добавленный ПВЗ.
Направление	Запрос выполняется курьерской службой. Ответ предоставляется ИС Золотого Яблока.

Запрос

Параметры заголовка

Параметр	Тип данных	Обязательность	Описание	Комментарий
Authorization	string	1	Access-token, выданнный сервисом	см. метод Авторизация в сервисе
content-type	string	1	Тип содержимого запроса	Заполняется "application/json"

Параметры запроса

№	Параметр			Тип данных	Обязательность	Описание	Комментарий
1	countryISOCode			string (2)	1	Код страны курьерской службы	Согласно стандарту "ISO 3166-1, alpha-2"
2	deliveryServiceCode			string (100)	1	Код курьерской службы	Оговаривается при интеграции с системой
3	id			string(100)	1	Идентификатор ПВЗ курьерской службы	Передаётся из курьерской службы
4	type			string(20)	1	Тип пункта выдачи	См. "Форматные таблицы" → "Таблица 1"
5	address			object	1	Объект, содержащий адресные данные
6		Address object type		object	1	Объект, содержащий адресную информацию.	Адресный объект (см. Приложение: Адресные типы данных)
7	openingHours			array of objects	1	Массив объектов с часами работы ПВЗ
8		dayOfWeek		enum	1	Идентификатор дня для которого назначается режим работы	См. "Форматные таблицы" → "Таблица 3"
9		workingDay		bool	1	Признак рабочего дня	Если включен, то ПВЗ работает в этот день недели
10		opens		string (15)	0	Время открытия ПВЗ	Согласно стандарту "ISO 8601" (hh:mm:ss)
11		closes		string (15)	0	Время закрытия ПВЗ	Согласно стандарту "ISO 8601" (hh:mm:ss)
12	phoneNumber			string (20)	0	Номер телефона ПВЗ	Без спецсимволов, только цифры (код страны и федеральный код)
13	isAvailable			boolean	1	Статус доступности ПВЗ	Если флаг включен, то ПВЗ активен, если выключен - то нет
14	orderStoragePeriod			int	1	Срок хранения заказа в календарных днях	Например: 5
15	options			object	1	Объект с опциями, доступными для ПВЗ
16		orderIssuing		bool	1	Есть возможность выдачи заказа	Если включен - то ПВЗ может выдавать заказы
17		orderReturning		bool	1	Есть возможность возврата заказа	Если включен - то ПВЗ может принимать возвраты
18		haveTryOn		bool	1	Есть примерочные и возможность примерки	Если включен, то в ПВЗ есть примерочные
19		havePartialBuy		bool	1	Есть возможность частичного выкупа	То есть, на ПВЗ могут провести частичную выдачу
20		packageMinWeight		int	1	Минимальный вес посылки для этого ПВЗ в граммах
21		packageMaxWeight		int	1	Максимальный вес посылки для этого ПВЗ в граммах
22		packageMaxLength		decimal	1	Максимальная длина посылки для ПВЗ в сантиметрах.	По оси X. С точностью до двух знаков после разделителя
23		packageMaxHeight		decimal	1	Максимальная высота посылки для ПВЗ в сантиметрах.	По оси Y. С точностью до двух знаков после разделителя
24		packageMaxWidth		decimal	1	Максимальная ширина посылки для ПВЗ в сантиметрах.	По оси Z. С точностью до двух знаков после разделителя
25	paymentOptions			object	1	Объект с вариантами оплаты при получении
26		haveCashPayment		bool	1	Есть наложенный платёж (постоплата)	Если включен - то оплата при получении возможна
27		haveCardPayment		bool	1	Есть оплата картой (терминал)	Если включен, то на ПВЗ принимают оплату картой
28		haveQrCodePayment		bool	1	Есть оплата QR-кодом (терминал, ПО на ПВЗ)	Если включен, то на ПВЗ есть оплата по QR-коду

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

{
    "countryISOCode": "RU",
    "deliveryServiceCode": "EXAMPLE_CS",
    "id": "PVZ-SPB-001",
    "type": "PICKPOINT",
    "address": {
      "addressType": "gar",
      "fullAddress": "190000, г Санкт-Петербург, Невский проспект, д 28",
      "regionFias": "c2deb16a-0330-4f05-821f-1d12d16a218a",
      "cityFias": "f1a154e5-7982-4d4b-a70d-5e9a01350320",
      "houseFias": "a1b2c3d4-5678-90ef-1234-567890abcdef",
      "flat": "",
      "latitude": 58.0167,
      "longitude": 56.235,
      "addressComment": "Цокольный этаж, вход с Невского проспекта"
    },
    "openingHours": [
      {
        "dayOfWeek": 1,
        "workingDay": true,
        "opens": "09:00:00",
        "closes": "21:00:00"
      },
      {
        "dayOfWeek": 2,
        "workingDay": true,
        "opens": "09:00:00",
        "closes": "21:00:00"
      },
      {
        "dayOfWeek": 3,
        "workingDay": true,
        "opens": "09:00:00",
        "closes": "21:00:00"
      },
      {
        "dayOfWeek": 4,
        "workingDay": true,
        "opens": "09:00:00",
        "closes": "21:00:00"
      },
      {
        "dayOfWeek": 5,
        "workingDay": true,
        "opens": "09:00:00",
        "closes": "21:00:00"
      },
      {
        "dayOfWeek": 6,
        "workingDay": true,
        "opens": "10:00:00",
        "closes": "20:00:00"
      },
      {
        "dayOfWeek": 7,
        "workingDay": false,
        "opens": null,
        "closes": null
      }
    ],
    "phoneNumber": "78121234567",
    "isAvailable": true,
    "orderStoragePeriod": 5,
    "options": {
      "orderIssuing": true,
      "orderReturning": true,
      "haveTryOn": true,
      "havePartialBuy": true,
      "packageMinWeight": 150,
      "packageMaxWeight": 10000,
      "packageMaxLength": 100,
      "packageMaxHeight": 100,
      "packageMaxWidth": 100
    },
    "paymentOptions": {
      "haveCashPayment": true,
      "haveCardPayment": true,
      "haveQrCodePayment": true
    }
}

Ответ

Коды ответов и сообщений

Код	Статус	Сообщение	Причина
200	ОК	A new pickpoint has been created	Все прошло успешно. Новый ПВЗ создан в справочнике ИС Золотого Яблока
400	Bad Request	Missing or inappropriate required parameters	Не переданы или некорретно заполнены обязательные поля
401	Unauthorized	Token is invalid	Ошибка аутентификации в КС
403	Forbidden	Has no permission	Запрещено в текущем контексте
500	Internal Server Error	Server unavailable	Сервер недоступен

Параметры ответа

Параметр	Тип данных	Обязательность	Описание	Комментарий
id	string	1	Подтверждённый код ПВЗ, переданный КС при создании	Например: "PVZ-SPB-001"

Пример успешного ответа

{
   "id": "PVZ-SPB-001"
}

Параметры неуспешного ответа

Параметр	Тип данных	Обязательность	Описание	Комментарий
error	string	1	Человекочитаемое описание ошибки	см. п. "Коды ответов и сообщений"

Пример неуспешного ответа

Неуспешный ответ

{
  "error": "Invalid request format"
}