Gets order items request information.

Gets order items request information. Items adding is asynchronously, as it can take a long time. The user must wait for the operation status to be either success or error.

HTTP Request

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

Path Parameters

company_id *	integer The ID of the company.
order_items_adding_id *	string The ID of order items request. It is obtained in response to a request to add items to orders.

* Required parameter

Responses

Code 200

Information about the asynchronous operation of adding items to orders.

{
  "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
      }
    ]
  }
}
Copied to clipboard

Representation

Collapse all

Expand all

Fields

created_at *	object
created_at.text *	string The time of request creation, in ISO 8601 format. Example - '2018-09-06T10:15:00+00:00'.
created_at.value *	number UNIX timestamp of request creation.
error	object Will be presented in case of status = error.
error.error_type *	string The type of error. `internal_error`: internal error. `request_is_not_json`: failed to parse request body to JSON format. `json_validation_failed`: the request does not match the scheme. `error_in_items`: some item contains errors. `duplicate_order_ids`: two or more same order_id was specified in request. Allowed values internal_error request_is_not_json json_validation_failed error_in_items duplicate_order_ids
error.per_order_errors[]	array Descriptions of error related to the certain orders.
error.per_order_errors[].description	string Error description.
error.per_order_errors[].error_type *	string The type of error. Allowed values item_numbers_not_unique order_not_found order_finished order_partially_finished order_cancelled other
error.per_order_errors[].order_id *	integer The ID of the order.
error.total_error *	string Description of error related to the whole request. For exapmple if falied JSON parsing.
status *	string Status of request processing. `error`: if an error occurs with at least one item, the entire request is transferred to the error status, and no items are added to the orders. queued`/in_progress`: request processing in progress, You must wait several time.` warning`: request is correct, some warnings was occured, but all items was successfully added to orders.` success`: all items was successfully added to orders. Allowed values queued in_progress success error warning
updated_at *	object
updated_at.text *	string The time of request update, in ISO 8601 format. Example - '2018-09-06T10:15:00+00:00'.
updated_at.value *	number UNIX timestamp of request update.
warning	object Will be presented in case of status = warning.
warning.per_order_warnings[] *	array Descriptions of warnings related to the certain orders.
warning.per_order_warnings[].description	string Warning description.
warning.per_order_warnings[].order_id *	integer The ID of the order.
warning.per_order_warnings[].warning_type *	string Warning type. `order_contains_items`: the order contains items, they will be replaced with new. Allowed values order_contains_items

* Required parameter

Code 401

Authorization failed. Send the correct OAuth token in the authorization header.

Code 403

You do not have access to this object.

Code 422

Incorrect input.

Code 504

Server error during request processing.