API интегратора

Описание методов API

Инструмент для подключения маркетплейсов, интернет-магазинов и других систем к сервису «Маркетплейсы. Отслеживание заказов»

Содержание страницы

Термины и определения

Описание порядка функционирования

Описание методов программного интерфейса

Термины и определения

Сервис (OMS) – сервис «Маркетплейсы. Управление заказами» в системе «Одно окно».

Интегратор - контрагент РЭЦ, который получил доступ к функциональности Сервиса посредством универсального API для Интегратора. Интеграция с eBay и Amazon осуществляется по уже разработанному eBay и Amazon API, поэтому к ним не применяется термин "Интегратор" в контексте данного документа.

ИС Интегратора - информационная система Интегратора.

ЭТП - электронная торговая площадка (Amazon, eBay).

ЭТП-аккаунт - сущность, которая хранит в себе ключи и токены для обращения к API ЭТП, а также для авторизации и аутентификации аккаунта Экспортера в API ЭТП.

Листинг - объявление о продаже товара в ЭТП

ЭТП-карточка товара - листинг, импортированный в Сервис

Описание порядка функционирования

1.1. На рисунке 1.1. иллюстрируется порядок выполнения операций при подключении ЭТП-аккаунта и импорте товаров и заказов. Описание шагов, отраженных на рисунке 1.1, приведено в таблице 1.1.

Рисунок 1.1. - Порядок выполнения операций при подключении ЭТП-аккаунта и импорте товаров и заказов.

Таблица 1.1. - Подключение ЭТП-аккаунта, импорт товаров и заказов.

Подключение ЭТП-аккаунта

Импорт товаров из ЭТП

Подключение ЭТП-аккаунта

Импорт заказов из ЭТП

19;ИС ЭТП;Получение списка Заказов из ИС ЭТП.;"Получение списка Заказов из ИС ЭТП. Требования к ИС Интегратора приведены в п. 2.1.5." 20;Сервис «OMS»;Ответ ИС ЭТП.;Ответ ИС ЭТП. 21;ИС ЭТП;Получение позиций Заказов из ИС ЭТП.;"Получение позиций Заказов из ИС ЭТП. Шаги 21-2 выполняются при импорте заказов из ИС Amazon." 22;Сервис «OMS»;Ответ ИС ЭТП.;Ответ ИС ЭТП. 23;Сервис «OMS»;Сохранение заказов.;"Сохранение заказов. При этом в Сервисе автоматически выполняются следующие действия: 1. Сохранение новых заказов. 2. Обновление статусов созданных ранее заказов. 3. Создание ЭТП-карточек товаров, если в составе заказа есть позиции еще не импортированных товаров. 4. Резервирование свободного остатка товаров под заказы для ЭТП-карточек товаров с подтвержденной связью." 24;ИС ЭТП;Обновление доступного количества товара в листингах.;"Обновление доступного количества товара в листингах для всех ЭТП-карточек товаров, связанных с карточкой продукции Каталога, кроме ЭТП-карточки товара указанной в заказе, созданном на шаге 23. Шаги 24-25 выполняется только если у карточки продукции Каталога есть подтвержденные связи более чем с одной ЭТП-карточкой товара. Требования к ИС Интегратора приведены в п. 2.1.6." 25;Сервис «OMS»;Ответ ИС ЭТП.;Ответ ИС ЭТП.

1.2. На рисунке 1.2. иллюстрируется порядок выполнения операций при подтверждении связей ЭТП-карточки товара и карточки продукции Каталога. Описание шагов, отраженных на рисунке 1.2., приведено в таблице 1.2.

Рисунок 1.2. - Порядок выполнения операций при подтверждении связей ЭТП-карточки товара и карточки продукции Каталога.

Таблица 1.2. - Подтверждение связей ЭТП-карточки товара и карточки продукции Каталога.

1;Сервис «OMS»;Подтверждение связи карточки продукции и ЭТП-карточки товара.;Подтверждение связи карточки продукции и ЭТП-карточки товара. 2;ИС ЭТП;Миграция листинга в Inventory модель данных.;"Миграция листинга в Inventory модель данных. Шаги 2-3 выполняются только при подтверждении связи для ЭТП-карточек товаров из ИС eBay." 3;Сервис «OMS»;Ответ ИС ЭТП.;Ответ ИС ЭТП. 4;ИС ЭТП;Обновление доступного количества товара в листинге.;"Обновление доступного количества товара в листинге. Требования к ИС Интегратора приведены в п. 2.1.6. " 5;Сервис «OMS»;Ответ ИС ЭТП.;Ответ ИС ЭТП. 6;Подсистема «ЕЛК»;Уведомление Экспортера о подтверждении связи.;Уведомление Экспортера о подтверждении связи. 7;Сервис «OMS»;Резервирование товаров под заказы.;Резервирование товаров под заказы. 8;ИС ЭТП;Обновление доступного количества товара в листингах.;"Обновление доступного количества товара в листингах для всех ЭТП-карточек товаров, связанных с карточкой продукции Каталога, кроме ЭТП-карточки товара, по которой доступное количество уже обновлено на шаге 2. Требования к ИС Интегратора приведены в п. 2.1.6. " 9;Сервис «OMS»;Ответ ИС ЭТП.;Ответ ИС ЭТП.

1.3. На рисунке 1.3 иллюстрируется порядок выполнения операции проверки наличия новых листингов в ИС ЭТП. Описание шагов, отраженных на рисунке 1.3, приведено в таблице 1.3.

Рисунок 1.3 - Порядок выполнения операции проверки наличия новых листингов в ИС ЭТП.

Таблица 1.3 - Проверка наличия новых листингов в ИС ЭТП.

1.4. На рисунке 1.4. иллюстрируется порядок выполнения операции проверки наличия новых заказов в ИС ЭТП. Описание шагов, отраженных на рисунке 1.4., приведено в таблице 1.4.

Рисунок 1.4. - Порядок выполнения операции проверки наличия новых заказов в ИС ЭТП.

Таблица 1.4. - Проверка наличия новых заказов.

1;ИС ЭТП;Получение списка Заказов из ИС ЭТП.;"Получение списка Заказов из ИС ЭТП. Требования к ИС Интегратора приведены в п. 2.1.5." 2;Сервис «OMS»;Ответ ИС ЭТП.;Ответ ИС ЭТП. 3;ИС ЭТП;Получение позиций Заказов из ИС ЭТП.;"Получение позиций Заказов из ИС ЭТП. Шаги 3-4 выполняются при импорте заказов из ИС Amazon." 4;Сервис «OMS»;Ответ ИС ЭТП.;Ответ ИС ЭТП. 5;Сервис «OMS»;Сохранение заказов.;"Сохранение заказов. При этом в Сервисе автоматически выполняются следующие действия: 1. Сохранение новых заказов. 2. Обновление статусов созданных ранее заказов. 3. Создание ЭТП-карточек товаров, если в составе заказа есть позиции еще не импортированных товаров. 4. Резервирование свободного остатка товаров под заказы для ЭТП-карточек товаров с подтвержденной связью." 6;ИС ЭТП;Обновление доступного количества товара в листингах.;"Обновление доступного количества товара в листингах для всех ЭТП-карточек товаров, связанных с карточкой продукции Каталога, кроме ЭТП-карточки товара указанной в заказе, созданном на шаге 5. Шаги 6-7 выполняется только если у карточки продукции Каталога есть подтвержденные связи более чем с одной ЭТП-карточкой товара. Требования к ИС Интегратора приведены в п. 2.1.6." 7;Сервис «OMS»;Ответ ИС ЭТП.;Ответ ИС ЭТП.

1.5. На рисунке 1.5. иллюстрируется порядок выполнения операции создания отправления заказа в ИС ЭТП. Описание шагов, отраженных на рисунке 1.5., приведено в таблице 1.5.

Рисунок 1.5. - Порядок выполнения операции создания отправления заказа в ИС ЭТП.

Таблица 1.5. - Создание отправления заказа в ИС ЭТП.

1.6. На рисунке 1.6. иллюстрируется порядок выполнения операции отмены заказа в Сервисе OMS. Описание шагов, отраженных на рисунке 1.6., приведено в таблице 1.6.

Рисунок 1.6. - Порядок выполнения операции отмены заказа в Сервисе OMS.

Таблица 1.6. - Отмена заказа в Сервисе OMS.

1;Сервис «OMS»;Выбор причины отмены заказа.;"Выбор причины отмены заказа. Шаги 1-8 выполняются только при отмене заказа в ИС Интегратора или ИС eBay." 2;ИС ЭТП;Получение допустимых причин отмены.;"Получение допустимых причин отмены. Требования к ИС Интегратора приведены в п. 2.1.9." 3;Сервис «OMS»;Ответ ИС ЭТП.;Ответ ИС ЭТП. 4;Подсистема «ЕЛК»;Вывод списка допустимых причин отмены.;Вывод списка допустимых причин отмены. 5;Сервис «OMS»;Отмена заказа.;Отмена заказа. 6;ИС ЭТП;Отмена заказа.;"Отмена заказа. Требования к ИС Интегратора приведены в п. 2.1.10" 7;Сервис «OMS»;Ответ ИС ЭТП.;Ответ ИС ЭТП. 8;Подсистема «ЕЛК»;Ответ ИС ЭТП.;Ответ ИС ЭТП. 9;Сервис «OMS»;Отмена заказа.;"Отмена заказа. Шаги 9-10 выполняются только при отмене заказа в ИС Amazon." 10;Сервис «OMS»;Создание XML-фида отмены заказа в Amazon.;Создание XML-фида отмены заказа в Amazon. 11;Сервис «OMS»;Отмена резервирования товаров под заказ.;Отмена резервирования товаров под заказ. 12;ИС ЭТП;Обновление доступного количества товаров в листингах.;"Обновление доступного количества товаров в листингах. Шаги 12-13 выполняются по отмененным позициям заказа для всех ЭТП-карточек товаров, связанным с карточками продукции Каталога, при условии, что эта связь подтверждена. Требования к ИС Интегратора приведены в п. 2.1.6. настоящего ПЗ. " 13;Сервис «OMS»;Ответ ИС ЭТП.;Ответ ИС ЭТП.

1.7. На рисунке 1.7. иллюстрируется порядок выполнения операции синхронизации товарного остатка в ИС ЭТП. Описание шагов, отраженных на рисунке 1.7., приведено в таблице 1.7.

Рисунок 1.7. - Порядок выполнения операции синхронизации товарного остатка в ИС ЭТП.

Таблица 1.7. - Синхронизация товарного остатка в ИС ЭТП.

1.8. На рисунке 1.8. иллюстрируется порядок выполнения операции обмена refresh_token на access_token в ИС ЭТП. Описание шагов, отраженных на рисунке 1.8., приведено в таблице 1.8.

Рисунок 1.8. - Порядок выполнения операции обмена refresh_token на access_token в ИС ЭТП.

Таблица 1.8. - Обмен refresh_token на access_token в ИС ЭТП.

Описание методов программного интерфейса

2.1. Для интеграции с API Сервиса на стороне Интегратора должны быть реализованы следующие методы API:

2.1.1. URI авторизации OAuth, на который пользователь будет переходить из Сервиса при подключении ЭТП-аккаунта: GET {oauth2_url}?redirect_uri={redirect_uri}&client_id={clientid}&response_type=code&state={state}&scope={scope}. Описание параметров запроса приведено в Таблице 2.1.1.

Таблица 2.1.1. – Описание параметров вызова URI авторизации OAuth (обязательные поля выделены жирным).

2.1.2. URI перенаправления OAuth, который ИС Интегратора загружает в браузер после согласия или отказа пользователя на авторизацию Сервиса:

2.1.2.1. POST {redirect_uri}/accept?state={state}&code={code} - в случае успешного предоставления доступа Сервису к ИС Интегратора. Описание параметров запроса приведено в Таблице 2.1.2.1.

Таблица 2.1.2.1. – Описание параметров запроса, вызываемого в случае успешного предоставления доступа Сервису (обязательные поля выделены жирным).

2.1.2.2. POST {redirect_uri}/reject?state={state}&error={error}&error_description={error_description} - в случае отказа в предоставлении доступа Сервису к ИС Интегратора или в случае неуспешного предоставления доступа. Описание параметров запроса приведено в Таблице 2.1.2.2.

2.1.2.2. – Описание параметров запроса, вызываемого в случае отказа или неуспешного предоставления доступа Сервису (обязательные поля выделены жирным).Таблица

2.1.3. Метод обмена oauth кода на refresh token в ИС Интегратора: POST {oauth2_url}?grant_type=authorization_code&code={code}&client_id={client_id}&client_secret={client_secret}. Описание параметров запроса и ответа приведено в Таблицах 2.1.3.1. и 2.1.3.2.

Таблица 2.1.3.1 – Описание параметров запроса обмена oauth кода на refresh token в ИС Интегратора (обязательные поля выделены жирным).

Таблица 2.1.3.2. – обмена oauth кода на refresh token в ИС Интегратора Описание параметров ответа на запрос (жирным выделены поля, которые всегда возвращаются в ответе).

2.1.4. Метод получения списка Листингов (товаров) в ИС Интегратора: GET {request_url}/inventoryItems. Описание параметров запроса и ответа приведено в Таблицах 2.1.4.1. и 2.1.4.2.

Таблица 2.1.4.1 – Описание параметров запроса получения списка Листингов (товаров) в ИС Интегратора (обязательные поля выделены жирным).

Таблица 2.1.4.2 – Описание параметров ответа на запрос получения списка Листингов (товаров) в ИС Интегратора (жирным выделены поля, которые всегда возвращаются в ответе).

number;Число;-;Номер страницы. size;Число;-;Размер страницы. totalElements;Число;-;Общее количество элементов. totalPages;Число;-;Общее количество страниц. content;Массив;Сохраняется в Сервисе.;Массив товаров listingId;Строка;Сохраняется в Сервисе.;Идентификатор товара в ИС Интегратора. title;Строка;Сохраняется в Сервисе.;Название товара. sku;Строка;Сохраняется в Сервисе.;Маркер, идентификатор товарной позиции, при помощи которого осуществляется сопоставление карточек продукции Каталога и ЭТП-карточек товаров в Сервисе. shipToLocationAvailability;Число;Сохраняется в Сервисе.;Количество товаров, доступных для покупки в Листингах с доставкой до покупателя. Товары без доставки до покупателя (самовывоз) не возвращаются в ответе. fulfillmentNetwork;Строка;Сохраняется в Сервисе.;"Сеть доставки листинга. Значения: 1.MERCHANT - сеть доставки продавца. Например, для Амазон это листинг по программе FBM. 2.TRADING_PLATFORM - сеть доставки ЭТП. Например, для Амазон это листинг по программе FBA." errors;Массив;-;Возвращается только если во время выполнения запроса произошла одна или несколько непредвиденных ошибок. code;Строка;Отображается в Журнале синхронизации;Код ошибки, определяющий тип возникшей ошибки. message;Строка;Отображается в Журнале синхронизации;Сообщение, описывающее состояние ошибки в удобочитаемой форме. details;Строка;Отображается в Журнале синхронизации;Дополнительные сведения, которые могут помочь понять или решить проблему.

2.1.5. Метод получения списка Заказов из ИС Интегратора: GET {request_url}/orders. Описание параметров запроса и ответа приведено в Таблицах 2.1.5.1. и 2.1.5.2.

Таблица 2.1.5.1. – Описание параметров запроса получения списка Заказов из ИС Интегратора (обязательные поля выделены жирным).

Таблица 2.1.5.2. – Описание параметров ответа на запрос получения списка Заказов из ИС Интегратора (жирным выделены поля, которые всегда возвращаются в ответе).

number;Число;-;Номер страницы. size;Число;-;Размер страницы. totalElements;Число;-;Общее количество элементов. totalPages;Число;-;Общее количество страниц. content;Массив;-;Массив элементов. buyerCheckoutNotes;Строка;Сохраняется в Сервисе.;Комментарий покупателя о заказе. cancelStatus;Объект;Сохраняется в Сервисе.;Информация об отмене заказа. cancelledDate;"Строка";Сохраняется в Сервисе.;Дата и время отмены заказа. Формат ISO 8601 [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z. cancelRequests;Массив;"Сохраняется в Сервисе. Если в ответе несколько запросов отмены, сохраняется (или обновляется) тот запрос, у которого cancelRequestedDate больше.;Сведения о запросах покупателя об отмене заказа. cancelReason;Строка;Сохраняется в Сервисе.;"Причина отмены заказа. Пример: "OUT_OF_STOCK_OR_CANNOT_FULFILL"" cancelRequestedDate;Строка;Сохраняется в Сервисе.;Дата и время создания запроса отмены заказа. Формат ISO 8601 [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z. cancelRequestState;Строка;Сохраняется в Сервисе.;"Статус запроса отмены заказа: 1.COMPLETED - успешно обработан запрос отмены заказа. 2.REJECTED - отклонен запрос отмены заказа. 3.REQUESTED - создан, но еще не обработан запрос отмены заказа." cancelState;Строка;Если cancelState = "CANCELED", то статус Заказа в Сервисе меняется на "Отменен".;"Статус отмены заказа: 1.CANCELED - отменен. 2.IN_PROGRESS - в процессе отмены. 3.NONE_REQUESTED - отмена не запрашивалась." creationDate;Строка;Сохраняется в Сервисе.;Дата и время создания заказа. Формат ISO 8601 [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z. fulfillmentStartInstructions;Объект;Сохраняется в Сервисе.;Спецификация доставки заказа (инструкции и пожелания покупателя). fulfillmentInstructionsType;Строка;"Сохраняется в Сервисе. Если есть хотя бы одно значение DIGITAL или PREPARE_FOR_PICKUP, то у пользователя нет возможности отправить заказ в карточке заказа в Сервисе. Для отправки заказа, пользователь переходит в ИС Интегратора.";"Метод отправки: 1.PICKUP - заказ на самовывоз. 2.SHIPMENT - продавец доставит заказ покупателю. 3.DIGITAL - электронный товар." fulfillmentNetwork;Строка;Сохраняется в Сервисе.;"Сеть исполнения заказа. Значения: MERCHANT - сеть доставки продавца. Например, для Амазон это заказ по программе FBM. TRADING_PLATFORM - сеть доставки ЭТП. Например, для Амазон это заказ по программе FBA." shipTo;Объект;Сохраняется в Сервисе.;Информация о доставке и контактная информация о покупателе. Не приходит, если fulfillmentChannel - TRADING_PLATFORM . companyName;Строка;Сохраняется в Сервисе.;Название компании покупателя. contactAddress;Объект;Сохраняется в Сервисе.;Адрес доставки покупателя. addressLine1;Строка;Сохраняется в Сервисе.;Первая строчка почтового адреса. addressLine2;Строка;Сохраняется в Сервисе.;Вторая строчка почтового адреса. city;Строка;Сохраняется в Сервисе.;Город назначения доставки. countryCode;Строка;Сохраняется в Сервисе.;Двухбуквенный код страны в формате ISO 3166-1 country;Строка;Сохраняется в Сервисе.;Страна назначения доставки. postalCode;Строка;Сохраняется в Сервисе.;Почтовый индекс stateOrProvince;Строка;Сохраняется в Сервисе.;Штат или провинция места доставки. email;Строка;Сохраняется в Сервисе.;e-mail покупателя. fullName;Строка;Сохраняется в Сервисе.;Полное имя покупателя. phoneNumber;Строка;Сохраняется в Сервисе.;Номер телефона получателя доставки. lastModifiedDate;Строка;Сохраняется в Сервисе.;Дата последнего изменения заказа. Формат ISO 8601 [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z. lineItems;Массив;Сохраняется в Сервисе.;Позиции заказа. shipByDate;Строка;Сохраняется в Сервисе.;"Самая последняя дата и время, к которым продавец должен отгрузить позицию, чтобы уложиться в ожидаемое окно доставки. Эта временная метка будет установлена eBay в зависимости от времени покупки и заявленного продавцом времени обработки. Формат ISO 8601 [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z." lineItemId;Строка;Сохраняется в Сервисе.;Уникальный идентификатор товара в ИС Интегратора. quantity;Число;Сохраняется в Сервисе.;Количество единиц товара в позиции в заказе. sku;Строка;Сохраняется в Сервисе.;Маркер, идентификатор товарной позиции. total;Объект;Сохраняется в Сервисе.;Общая цена, которую покупатель должен заплатить за позицию после того, как будут добавлены все затраты (стоимость позиции, стоимость доставки, налоги) за вычетом любых скидок и / или рекламных акций. currency;Строка;Сохраняется в Сервисе.;Валюта после конвертации на стороне ЭТП. Трехбуквенный код в формате ISO 4217 value;Строка;Сохраняется в Сервисе.;Сумма в валюте после конвертации. orderFulfillmentStatus;Строка;"Сохраняется в Сервисе только при импорте заказов (при первом и повторных подключениях ЭТП-аккаунта): "Не обработан", если cancelState != CANCELED, orderFulfillmentStatus != FULFILLED и текущий статус заказа не "Завершен". "Обработан", если cancelState != CANCELED и orderFulfillmentStatus = FULFILLED и текущий статус заказа не "Завершен".";"Статус отправления всего заказа: 1.FULFILLED - отправлено. 2.IN_PROGRESS - частично отправлено (есть еще не отправленные позиции заказа). 3.NOT_STARTED - не отправлена ни одна позиция заказа." orderId;Строка;Сохраняется в Сервисе.;Уникальный идентификатор заказа из ЭТП. orderPaymentStatus;Логическое;Сохраняется в Сервисе.;"Статус оплаты заказа: false - "Не оплачено". true - "Оплачено". orderRefundStatus;Строка;Сохраняется в Сервисе.;"Статус возврата заказа: 0 - Нет возврата. 1 - Частичный возврат. 2 - Полный возврат." errors;Массив;Возвращается только если во время выполнения запроса произошла одна или несколько непредвиденных ошибок. code;Строка;Отображается в Журнале синхронизации;Код ошибки, определяющий тип возникшей ошибки. message;Строка;Отображается в Журнале синхронизации;Сообщение, описывающее состояние ошибки в удобочитаемой форме. details;Строка;Отображается в Журнале синхронизации;Дополнительные сведения, которые могут помочь понять или решить проблему.

2.1.6. Обновление доступного количества товара в листингах в ИС Интегратора: PATCH {request_url}/inventoryItems/{inventoryItemId}. Описание параметров запроса и ответа приведено в Таблицах 2.1.6.1., 2.1.6.2. и 2.1.6.3.

Таблица 2.1.6.1. – Описание параметров запроса обновление доступного количества товара в листингах в ИС Интегратора (обязательные поля выделены жирным).

Таблица 2.1.6.2. – Описание входных параметров запроса обновление доступного количества товара в листингах в ИС Интегратора (обязательные поля выделены жирным).

Таблица 2.1.6.3. – Описание параметров ответа на запрос обновления доступного количества товара в листингах в ИС Интегратора (жирным выделены поля, которые всегда возвращаются в ответе).

2.1.7. Метод получения перечня возможных перевозчиков в ИС Интегратора: GET {request_url}/shippingCarrierDetails. Описание параметров запроса и ответа приведено в Таблицах 2.1.7.1. и 2.1.7.2.

Таблица 2.1.7.1. – Описание параметров запроса получения перечня возможных перевозчиков. (обязательные поля выделены жирным).

Таблица 2.1.7.2. – Описание параметров ответа на запрос получения перечня возможных перевозчиков. (жирным выделены поля, которые всегда возвращаются в ответе).

2.1.8. Создание отправления заказа: POST {request_url}/orders/{orderId}/shippingFulfillment. Описание параметров запроса и ответа приведено в Таблицах 2.1.8.1., 2.1.8.2. и 2.1.8.3.

Таблица 2.1.8.1. – Описание параметров запроса создания отправления заказа в ИС Интегратора (обязательные поля выделены жирным).

Таблица 2.1.8.2. – Описание параметров тела запроса создания отправления заказа в ИС Интегратора (обязательные поля выделены жирным).

Таблица 2.1.8.3. – Описание параметров ответа на запрос создания отправления заказа в ИС Интегратора (жирным выделены поля, которые всегда возвращаются в ответе).

2.1.9. Получение допустимых причин отмены в ИС Интегратора: GET {request_url}/cancellationAvailability. Описание параметров запроса и ответа приведено в Таблицах 2.1.9.1. и 2.1.9.2.

Таблица 2.1.9.1. – (обязательные поля выделены жирным).Описание параметров запроса получения допустимых причин отмены в ИС Интегратора

Таблица 2.1.9.2. – Описание параметров ответа на запрос получения допустимых причин отмены в ИС Интегратора (жирным выделены поля, которые всегда возвращаются в ответе).

available;Логический;-;Если установлено значение true, указанный заказ может быть отменен. Если false, заказ не может быть отменен. availableCancelReason;Массив;-;Список одной или нескольких причин, по которым покупатель или продавец может отменить этот заказ. Возвращается только в том случае, если eligible = true. name;Строка;Передается в запросе отмены заказа, требования к которому приведены в п. 6.2.10 настоящего ПЗ.;"Причина отмены заказа. Пример: "OUT_OF_STOCK_OR_CANNOT_FULFILL"" description;Строка;Выводится пользователю на интерфейс, если eligible = true;"Описание причины отмены на русском языке. Отображается пользователю в выпадающем списке. Пример: "Товара нет в наличии"" failureReason;Массив;Выводится пользователю на интерфейс, если eligible = false;Список одной или нескольких причин, по которым этот заказ не может быть отменен. Возвращается только в том случае, если eligible = false. name;Строка;Выводится пользователю на интерфейс, если eligible = false;Причина невозможности отмены заказа. description;Строка;Выводится пользователю на интерфейс, если eligible = false;Описание причины невозможности отмены на русском языке. Отображается пользователю на интерфейсе. errors;Массив;-;Возвращается только если во время выполнения запроса произошла одна или несколько непредвиденных ошибок. code;Строка;Выводится пользователю на интерфейс.;Код ошибки, определяющий тип возникшей ошибки. message;Строка;Выводится пользователю на интерфейс.;Сообщение, описывающее состояние ошибки в удобочитаемой форме. details;Строка;Выводится пользователю на интерфейс.;Дополнительные сведения, которые могут помочь понять или решить проблему.

2.1.10. Отмена заказа в ИС Интегратора: POST {request_url}/cancellation. Описание параметров запроса и ответа приведено в Таблицах 2.1.10.1. и 2.1.10.2.

Таблица 2.1.10.1. – Описание параметров запроса отмены заказа в ИС Интегратора (обязательные поля выделены жирным).

Таблица 2.1.10.2. – Описание параметров ответа на запрос отмены заказа в ИС Интегратора (жирным выделены поля, которые всегда возвращаются в ответе).

2.1.11. Обмен refresh_token на access_token в ИС Интегратора: POST {oauth2_url}?grant_type=refresh_token&refresh_token={refresh_token}&client_id={client_id}&client_secret={client_secret}. Описание параметров запроса и ответа приведено в Таблицах 2.1.11.1. и 2.1.11.2.

Таблица 2.1.11.1. – Описание параметров запроса обмена refresh_token на access_token в ИС Интегратора (обязательные поля выделены жирным).

Таблица 2.1.11.2. – Описание параметров ответа на запрос обмена refresh_token на access_token в ИС Интегратора (жирным выделены поля, которые всегда возвращаются в ответе).

2.2. Для выполнения запросов, перечисленных в п.п. 2.1.4, 2.1.5, 2.1.6, 2.1.7, 2.1.8, 2.1.9, 2.1.10, необходимо передать в заголовке запроса Autorization: Bearer <access_token>

2.3. В заголовках ответов на все запросы, перечисленные в п.2. необходимо передать Content-Type: application/json