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": "2c0cedb0-e1fa-42b4-accf-1cfbdf652b16",
  "object": "bulk_action",
  "action_type": "delete_products",
  "record_ids": [
    "59c4fceb-adce-4d3c-a28a-f046d1a9929a",
    "9ea69adf-0d30-4bb7-bc27-7c65f6bae82a",
    "d652535f-2c11-45bc-a8de-1ffa1ca82811",
    "7182b82d-b4fc-4675-b84c-d753c6f65c3e",
    "da381e7f-c4e5-4a34-b3f7-b1a44f88150b"
  ],
  "skipped_record_ids": [],
  "status": "pending",
  "created_at": 1767909674,
  "updated_at": 1767909674
}

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.