Skip to main content
GET
/
v1
/
bulk_actions
/
{id}
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/bulk_actions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "86be9293-4e7c-4ba8-8471-8293c50816c7",
  "object": "bulk_action",
  "action_type": "delete_products",
  "record_ids": [
    "6e960976-949a-4703-92d2-890ee8dbdff9",
    "660bc22e-09c1-41b5-9435-9f073a7bc7fb",
    "4d370c5a-bbdb-402e-9e5a-65e29d15fbfa",
    "26a3e908-d4d5-4f75-80ac-c8e11e4bef6d",
    "168ac170-7e4e-416e-904c-d6903d0be591"
  ],
  "skipped_record_ids": [],
  "status": "pending",
  "created_at": 1770234840,
  "updated_at": 1770234840
}

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.

​
action_type
string

The type of action to be performed. Possible values include:

  • delete_customers
  • delete_products
​
record_ids
array

The id of records to perform the bulk action on.

​
skipped_record_ids
array

The array of ids that are skipped due to the action not being applicable to them.

​
status
string

The status of the bulk action. Possible values include:

  • completed: The bulk action has been executed, possibly with some errors.
  • invalid: The bulk action contains no record_ids that support the given action.
  • pending: The bulk action is pending and not yet processed.
  • processing: The bulk action is currently being processed.
  • succeeded: The bulk action has succeeded with no errors for all the supporting record_ids.
​
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.