Graph API Version

Check Batch Request Status

Reading

The status of a batch request.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
errors

List of sample errors(does not include all errors) - cases where item update was blocked.

errors_total_count
int32

Total number of errors

handle
string

Handle of a batch request. Such handles are part of the response payload of API endpoints used to submit Catalog Batch API requests (example: /items_batch).

ids_of_invalid_requests
list<string>

List of retailer ids for which the requests failed

status
string

Status of a batch request. Possible values are:

  • Scheduled - A new action enters 'scheduled' state. Scheduled actions await to be dispatched.
  • Dispatched - The action was added to the queue.
  • Started - The action was started; some of the requests might have been updated.
  • Finished - The action was completed successfully; individual requests with errors were not saved.
  • Canceled - The action was manually canceled.
  • Error - During the execution of the action, an unexpected issue occurred; some of the requests might not have finished successfully.

warnings

List of sample warnings for the submitted requests. Note that a warning may be purely a recommendation or may indicate that some of the field values were not updated.

warnings_total_count
int32

Total number of warnings

Creating

You can't perform this operation on this endpoint.

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.