unallocate

Owned by Former user (Deleted)
Last updated: Jun 16, 2022 by Admin Doc Maxoptra
1 min read


Данный запрос используется для отпланирования заказов в Максоптре. Чтобы отпланировать заказы в Максоптре, API использует структуру application/xml и HTTP-метод POST.

Вы можете отпланировать не более 50 заказов за один запрос.


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

#

Название атрибута

Тип данных

Длина

Обязательно

Описание

Секция аутентификации
1sessionIDТекст
ДаИдентификатор сессии, полученный от сервера после запроса авторизации.

Секция заказов

1

orderReference

Текст

64

Да

Внешний идентификатор заказа (Поле "Идентификатор заказа" в Максоптре).


Example of unallocate request

Headers:

Метод: POST

URL: [account-name].maxoptra.com/rest/2/distribution-api/schedules/unallocate

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


XML (тело запроса): 

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


Ответ unallocate

Чтобы отпланировать заказ в Максоптре, API использует структуру application/xml в качестве структуры ответа.


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

#

Название поля

Описание

1

orderReference

Внешний идентификатор (Поле «Идентификатор заказа» в Максоптре)

2

status

Статус выполняемой операции для указанного заказа. Возможные значения представлены в разделе "Статусы операций создания, редактирования и удаления".

3

errors


3.1

error


3.1.1

errorCode

Код ошибки. Возможные значения представлены в разделе "Коды ошибок и предупреждений".

3.1.2

errorMessage

Описание ошибки. Возможные значения представлены в разделе "Коды ошибок и предупреждений".

4

warnings


4.1

warning


4.1.1

warningCode

Код предупреждения Возможные значения представлены в разделе "Коды ошибок и предупреждений".

4.1.2

warningMessage

Описание предупреждения. Возможные значения представлены в разделе "Коды ошибок и предупреждений".


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<apiResponse>
 <orderReferences>
  <orderReference>
   <orderReference>mID2427845</orderReference>
   <success>true</success>
  </orderReference>
  <orderReference>
   <orderReference>mID2427846</orderReference>
   <success>true</success>
  </orderReference>
  <orderReference>
   <orderReference>mID2427844</orderReference>
   <success>true</success>
  </orderReference>
 </orderReferences>
</apiResponse>


См. также

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

save

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

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

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

Удаление заказов и рейсов из расписания