Получает информацию об запросе добавления товарного состава.

  1. HTTP-запрос
  2. Path-параметры
  3. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 401
    3. Код 403
    4. Код 422
    5. Код 504

Получает информацию об запросе добавления товарного состава. Добавление товаров сделано асинхронным, так как может занимать много времени. Пользователь должен дождаться, когда статус операции будет либо success, либо error.

HTTP-запрос

GET https://courier.yandex.ru/companies/{company_id}/orders/-/items-addings/{order_items_adding_id}

Path-параметры

company_id *

integer

ID компании.

order_items_adding_id *

string

ID запроса на добавление товарного состава. Получается в ответе на запрос добавления товаров к заказам.

company_id *

integer

ID компании.

order_items_adding_id *

string

ID запроса на добавление товарного состава. Получается в ответе на запрос добавления товаров к заказам.

Ответы

Код 200

Информация об асинхронной операции добавления товаров к заказам.

{
  "created_at": {
    "text": string,
    "value": number
  },
  "error": {
    "error_type": string,
    "per_order_errors": [
      {
        "description": string,
        "error_type": string,
        "order_id": integer
      }
    ],
    "total_error": string
  },
  "status": string,
  "updated_at": {
    "text": string,
    "value": number
  },
  "warning": {
    "per_order_warnings": [
      {
        "description": string,
        "order_id": integer,
        "warning_type": string
      }
    ]
  }
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

created_at *

object

created_at.text *

string

Время создания запроса в формате ISO 8601. Пример - '2018-09-06T10:15:00+00:00'.

created_at.value *

number

UNIX timestamp создания запроса.

error

object

Присутствует в случае если status = error.

error.error_type *

string

Тип ошибки. internal_error: внутренняя ошибка. request_is_not_json: не удалось преобразовать запрос к JSON формату. json_validation_failed: запрос не соответствует схеме. error_in_items: в некоторых товарах есть ошибка. duplicate_order_ids: некоторые order_id были указаны в запросе более одного раза.

Возможные значения
  1. internal_error
  2. request_is_not_json
  3. json_validation_failed
  4. error_in_items
  5. duplicate_order_ids

error.per_order_errors[]

array

Описание ошибок связанных с конкретными заказами.

error.per_order_errors[].description

string

Описание ошибки.

error.per_order_errors[].error_type *

string

Тип ошибки.

Возможные значения
  1. item_numbers_not_unique
  2. order_not_found
  3. order_finished
  4. order_partially_finished
  5. order_cancelled
  6. other

error.per_order_errors[].order_id *

integer

ID заказа.

error.total_error *

string

Описание ошибки связанной со всем запросом. Например, если не удалось распарсить JSON.

status *

string

Статус обработки запроса. error: если как минимум с одним товаром возникла ошибка, весь запрос переводится в статус error, и добавления товаров к заказам не происходит queued`/in_progress: обработка запроса в процессе, надо подождать некоторое время. warning: запрос обработан корректно, возникли некоторые предупреждения, но товары успешно добавлены. success`: все товары товары успешно добавлены.

Возможные значения
  1. queued
  2. in_progress
  3. success
  4. error
  5. warning

updated_at *

object

updated_at.text *

string

Время обновления запроса в формате ISO 8601. Пример - '2018-09-06T10:15:00+00:00'.

updated_at.value *

number

UNIX timestamp обновления запроса.

warning

object

Присутствует в случае если status = warning.

warning.per_order_warnings[] *

array

Описание предупреждений связанных с конкретными заказами.

warning.per_order_warnings[].description

string

Описание предупреждения.

warning.per_order_warnings[].order_id *

integer

ID заказа.

warning.per_order_warnings[].warning_type *

string

Тип предупреждения. order_contains_items: заказ уже содержит товары, они будут перезаписаны.

Возможные значения
  1. order_contains_items

created_at *

object

created_at.text *

string

Время создания запроса в формате ISO 8601. Пример - '2018-09-06T10:15:00+00:00'.

created_at.value *

number

UNIX timestamp создания запроса.

error

object

Присутствует в случае если status = error.

error.error_type *

string

Тип ошибки. internal_error: внутренняя ошибка. request_is_not_json: не удалось преобразовать запрос к JSON формату. json_validation_failed: запрос не соответствует схеме. error_in_items: в некоторых товарах есть ошибка. duplicate_order_ids: некоторые order_id были указаны в запросе более одного раза.

Возможные значения
  1. internal_error
  2. request_is_not_json
  3. json_validation_failed
  4. error_in_items
  5. duplicate_order_ids

error.per_order_errors[]

array

Описание ошибок связанных с конкретными заказами.

error.per_order_errors[].description

string

Описание ошибки.

error.per_order_errors[].error_type *

string

Тип ошибки.

Возможные значения
  1. item_numbers_not_unique
  2. order_not_found
  3. order_finished
  4. order_partially_finished
  5. order_cancelled
  6. other

error.per_order_errors[].order_id *

integer

ID заказа.

error.total_error *

string

Описание ошибки связанной со всем запросом. Например, если не удалось распарсить JSON.

status *

string

Статус обработки запроса. error: если как минимум с одним товаром возникла ошибка, весь запрос переводится в статус error, и добавления товаров к заказам не происходит queued`/in_progress: обработка запроса в процессе, надо подождать некоторое время. warning: запрос обработан корректно, возникли некоторые предупреждения, но товары успешно добавлены. success`: все товары товары успешно добавлены.

Возможные значения
  1. queued
  2. in_progress
  3. success
  4. error
  5. warning

updated_at *

object

updated_at.text *

string

Время обновления запроса в формате ISO 8601. Пример - '2018-09-06T10:15:00+00:00'.

updated_at.value *

number

UNIX timestamp обновления запроса.

warning

object

Присутствует в случае если status = warning.

warning.per_order_warnings[] *

array

Описание предупреждений связанных с конкретными заказами.

warning.per_order_warnings[].description

string

Описание предупреждения.

warning.per_order_warnings[].order_id *

integer

ID заказа.

warning.per_order_warnings[].warning_type *

string

Тип предупреждения. order_contains_items: заказ уже содержит товары, они будут перезаписаны.

Возможные значения
  1. order_contains_items

Код 401

Ошибка авторизации. Отправьте правильный OAuth-токен в заголовке авторизации.

Код 403

У вас нет доступа к этому объекту.

Код 422

Неправильный ввод.

Код 504

Ошибка сервера при обработке запроса.