Skip to main content
GET
/
v1
/
batch_operations
/
{id}
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/batch_operations/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "9aca21da-503f-4405-82c2-d3771ac3c430",
  "object": "batch_operation",
  "body": null,
  "http_method": "GET",
  "path": "/v1/products",
  "query_params": null,
  "response_body": null,
  "response_status": null,
  "status": "pending",
  "batch": "b0903efa-9e9e-4a73-b554-f43f4fd53e5b",
  "created_at": 1776176511,
  "updated_at": 1776176511
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
body
object

The JSON request body for this operation.

​
http_method
string

The HTTP method for this operation – one of DELETE, GET, PATCH, POST, or PUT.

​
path
string

The API path for this operation. Must start with / and contain only valid URL characters.

​
query_params
object

The query parameters for this operation.

​
response_body
object

The JSON response body returned by this operation.

​
response_status
integer | null

The HTTP response status code returned by this operation.

​
status
string

The status of this operation. Possible values include:

  • completed: The operation was executed and a response was received.
  • failed: The operation encountered an internal error and could not be executed.
  • in_progress: The operation is currently being executed.
  • pending: The operation has not yet started execution.
  • timed_out: The operation exceeded the allowed execution time.
​
batch

The batch this operation belongs to.

Expandable – The associated batch ID.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.