Изменение созданного ранее ПВЗ в справочнике

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

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

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

Запрос

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

Параметр	Тип данных	Обязательность	Описание	Комментарий
id	string	1	Идентификатор ПВЗ курьерской службы	Идентификатор ПВЗ курьерской службы, переданный при создании ПВЗ в справочнике

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

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

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

{
    "type": "POSTOMAT",
    "address": {
      "addressType": "coord",
      "fullAddress": "125009, г Москва, Тверская ул, д 7",
      "cityFias": "2763c110-cb8b-416a-9dac-ad28a55b4402",
      "latitude": 55.755816,
      "longitude": 37.617633,
      "flat": "",
      "addressComment": "ТЦ Этажи, 1 этаж, у главного входа"
    },
    "openingHours": [
      {
        "dayOfWeek": 1,
        "workingDay": true,
        "opens": "10:00:00",
        "closes": "22:00:00"
      },
      {
        "dayOfWeek": 2,
        "workingDay": true,
        "opens": "10:00:00",
        "closes": "22:00:00"
      },
      {
        "dayOfWeek": 3,
        "workingDay": true,
        "opens": "10:00:00",
        "closes": "22:00:00"
      },
      {
        "dayOfWeek": 4,
        "workingDay": true,
        "opens": "10:00:00",
        "closes": "22:00:00"
      },
      {
        "dayOfWeek": 5,
        "workingDay": true,
        "opens": "10:00:00",
        "closes": "22:00:00"
      },
      {
        "dayOfWeek": 6,
        "workingDay": false,
        "opens": null,
        "closes": null
      },
      {
        "dayOfWeek": 7,
        "workingDay": false,
        "opens": null,
        "closes": null
      }
    ],
    "phoneNumber": null,
    "isAvailable": true,
    "orderStoragePeriod": 4,
    "options": {
      "orderIssuing": true,
      "orderReturning": false,
      "haveTryOn": false,
      "havePartialBuy": false,
      "packageMinWeight": 50,
      "packageMaxWeight": 3000,
      "packageMaxLength": 45,
      "packageMaxHeight": 27.9,
      "packageMaxWidth": 30
    },
    "paymentOptions": {
      "haveCashPayment": false,
      "haveCardPayment": true,
      "haveQrCodePayment": true
    }
}

Ответ

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

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

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

200 ОК

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

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

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

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

{
  "error": "Invalid request format"
}