delete

Запрос delete

Для запроса удаления заказов в приложении API использует структуру application/xml и HTTP-метод POST.

Примечание С помощью данного метода можно удалять одновременно несколько заказов.

Входные данные запроса delete

#	Название поля	Тип данных	Длина	Обязательность	Описание
Секция аутентификации
1	sessionID	Текст		Да	Идентификатор сессии, полученный от сервера после запроса авторизации. Срок жизни сессии – 5 минут.. Если в течении этого времени в рамках сессии были проведены запросы, то срок жизни сессии увеличивается еще на 5 минут
Секция заказов
1	orderReference	Текст	64	Нет	Внешняя ссылка (Поле «Идентификатор заказа» в приложении)

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

Заголовки:

Метод: POST

URL: [account-name].maxoptra.com/rest/2/distribution-api/orders/delete

Структура: application/xml

XML:

<?xml version="1.0" encoding="UTF-8"?>
<apiRequest>
   <sessionID>8aa519d2c0af4f37a27a42a995528199</sessionID>
   <orders>
      <order>
         <orderReference>mID5670733</orderReference>
      </order>
      <order>
        <orderReference>mID5670734</orderReference>
     </order>
   </orders>
</apiRequest>

ответ delete

При удалении заказов API использует структуру application/xml в качестве формата ответа

Выходные данные ответа delete

#	Название поля	Описание
1	orderReference	Внешняя ссылка (Поле «Идентификатор заказа» в приложении)
2	status	Статус выполняемой операции для указанного заказа. Возможные значения представлены в Приложении 1.
3	errors
3.1	error
3.1.1	errorCode	Код ошибки. Возможные значения представлены в Приложении 2.
3.1.2	errorMessage	Описание ошибки. Возможные значения представлены в Приложении 2.
4	warnings
4.1	warning
4.1.1	warningCode	Код предупреждения Возможные значения представлены в Приложении 2.
4.1.2	warningMessage	Описание предупреждения. Возможные значения представлены в Приложении 2.

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

<?xml version='1.0' encoding='UTF-8' standalone='yes'?>
<apiResponse version="1.0">
  <orders>
    <order>
      <orderReference>mID5670733</orderReference>
      <status>Deleted</status>
    </order>
    <order>
      <orderReference>mID5670734</orderReference>
      <status>Error</status>
      <errors>
        <error>
          <errorCode>1103</errorCode>
          <errorMessage>
            <![CDATA[ "Job with same reference is already allocated" ]]>
          </errorMessage>
        </error>
      </errors>
    </order>
  </orders>
</apiResponse>

*Следует отметить что предупреждения не влияют на удаление заказа и несут в себе исключительно информационную нагрузку.

См. также

Методы API. Заказы

save

Статусы заказов

Статусы операций создания, редактирования и удаления заказов

Коды ошибок и предупреждений

Удаление заказов