Catalog

Check Batch Request Status

Use this guide to learn how the GET /{catalog_id}/check_batch_request_status endpoint checks the status of a batch request.

To get the status of a batch request, use a handle (returned from a call to {catalog_id}/items_batch) and make a GET call to:

https://graph.facebook.com/<API_VERSION>/<CATALOG_ID>/check_batch_request_status?handle=<HANDLE>

Supported Fields

FieldDescription

handle

Type: string

Required.

Unique handle of a batch request.

load_ids_of_invalid_requests

Type: boolean

Optional.

Boolean field to load ids of failed requests.

For more details, see API reference.

Examples

Sample Request - /{catalog_id}/check_batch_request_status

curl -G \
  -d 'handle=AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q'-d 'access_token=<ACCESS_TOKEN>'
  https://graph.facebook.com/<API_VERSION>/<CATALOG_ID>/check_batch_request_status

Sample Response - /{catalog_id}/check_batch_request_status

{
    "data": [
        {
            "status": "finished",
            "errors_total_count": 1,
            "errors": [
                {
                    "line": 0,
                    "id": "retailer-4",
                    "message": "Invalid value: Value passed at position 0 (id=retailer-199) is invalid: \"You cannot create a EntProductItem without required field Availability\""
                }
            ]
            "warnings": [
            ],
            "ids_of_invalid_requests": [
            ]

        }
    ]
}

Status

StatusExplanation

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.

Learn More